Skip to content

Commit

Permalink
Add two new how to files and fix errors in the last commit
Browse files Browse the repository at this point in the history
  • Loading branch information
amd-jnovotny committed Jun 25, 2024
1 parent a40a782 commit 9351c4b
Show file tree
Hide file tree
Showing 5 changed files with 1,328 additions and 7 deletions.
13 changes: 7 additions & 6 deletions docs/how-to/configuring-runtime-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ for each setting:

Use ``--brief`` to suppress printing current value and/or ``-c 0`` to suppress truncation of the descriptions.

Any setting which is boolean (``omnitrace-avail --settings --value --brief --filter bool``)
accepts a case insensitive match to nearly all common expressions for boolean logic:
Any setting which is a Boolean (``omnitrace-avail --settings --value --brief --filter bool``)
accepts a case insensitive match to nearly all common expressions for Boolean logic:
``ON``, ``OFF``, ``YES``, ``NO``, ``TRUE``, ``FALSE``, ``0``, ``1``, etc.

Exploring components
Expand Down Expand Up @@ -1191,7 +1191,7 @@ Use ``omnitrace-avail -G <filename> -F txt json xml`` to generate default
configuration files of each format and, optionally,
include the ``--all`` flag for descriptions, etc.
Configuration files are specified via the ``OMNITRACE_CONFIG_FILE`` environment variable
and by default will look for ```${HOME}/.omnitrace.cfg``` and ``${HOME}/.omnitrace.json``.
and by default will look for ``${HOME}/.omnitrace.cfg`` and ``${HOME}/.omnitrace.json``.
Multiple configuration files can be concatenated using the ``:`` symbol, for example:
.. code-block:: shell
Expand All @@ -1205,8 +1205,8 @@ Sample text configuration file
-----------------------------------
Text files support very basic variables and are case-insensitive.
Variables are created when an lvalue starts with a ``$`` and are
dereferenced when they appear as rvalues.
Variables are created when an left value starts with a ``$`` and are
de-referenced when they appear as right values.
Entries in the text configuration file which do not match to a known setting
in ``omnitrace-avail`` but are prefixed with ``OMNITRACE_`` are interpreted as
Expand Down Expand Up @@ -1349,4 +1349,5 @@ to set ``OMNITRACE_ADD_SECONDARY=false``:
</OMNITRACE_ADD_SECONDARY>
</settings>
</omnitrace>
</timemory_xml>
</timemory_xml>
3 changes: 2 additions & 1 deletion docs/how-to/configuring-validating-environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,5 @@ If Omnitrace was built with Python support, validate these additional commands:
.. code-block:: shell
which omnitrace-python
omnitrace-python --help
omnitrace-python --help
Loading

0 comments on commit 9351c4b

Please sign in to comment.