From bd74bf3069e15715f07521b076daa8541a698224 Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Wed, 3 Jul 2024 09:34:50 -0400 Subject: [PATCH] Complete second proofreading with fixes and minor formatting changes. --- docs/how-to/performing-causal-profiling.rst | 6 +++--- docs/how-to/profiling-python-scripts.rst | 2 +- docs/how-to/understanding-omnitrace-output.rst | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/how-to/performing-causal-profiling.rst b/docs/how-to/performing-causal-profiling.rst index d1ef49ef4..c0f8eccb1 100644 --- a/docs/how-to/performing-causal-profiling.rst +++ b/docs/how-to/performing-causal-profiling.rst @@ -54,7 +54,7 @@ where ``foo`` is ideally 30% faster than ``bar``: No matter how many optimizations are applied to ``foo``, the application will always require the same amount of time because the end-to-end performance is limited by ``bar``. However, a 5% speed-up -in ``bar`` will result in the +in ``bar`` results in the end-to-end performance improving by 5%. This trend continues linearly, with a 10% speed-up in ``bar`` yielding a 10% speed-up in end-to-end performance, and so on, up to a 30% speed-up, at which point ``bar`` runs as fast as ``foo``. @@ -149,7 +149,7 @@ There are three key differences between the two backends: In general, the ``perf`` backend is preferred over the ``timer`` backend when sufficient security priviledges permit its usage. -If ``OMNITRACE_CAUSAL_BACKEND`` is set to ``auto``, Omnitrace will fallback +If ``OMNITRACE_CAUSAL_BACKEND`` is set to ``auto``, Omnitrace falls back to using the ``timer`` backend only if the ``perf`` backend fails. If ``OMNITRACE_CAUSAL_BACKEND`` is set to ``perf`` and using this backend fails, Omnitrace aborts. @@ -537,7 +537,7 @@ Using ``omnitrace-causal`` with other launchers like ``mpirun`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``omnitrace-causal`` executable is intended to assist with application replay -and is designed to always be at the start of the command-line as the primary process. +and is designed to always be at the start of the command line as the primary process. ``omnitrace-causal`` typically adds a ``LD_PRELOAD`` of the Omnitrace libraries into the environment before launching the command to inject the functionality required to start the causal profiling tooling. However, this is problematic diff --git a/docs/how-to/profiling-python-scripts.rst b/docs/how-to/profiling-python-scripts.rst index 3d52792d1..f080f47a3 100644 --- a/docs/how-to/profiling-python-scripts.rst +++ b/docs/how-to/profiling-python-scripts.rst @@ -7,7 +7,7 @@ Profiling Python scripts **************************************************** `Omnitrace `_ supports profiling Python code at the -source-level and/or the script-level. +source level and the script level. Python support is enabled via the ``OMNITRACE_USE_PYTHON`` and the ``OMNITRACE_PYTHON_VERSIONS=".`` CMake options. Alternatively, to build multiple Python versions, use diff --git a/docs/how-to/understanding-omnitrace-output.rst b/docs/how-to/understanding-omnitrace-output.rst index 292bafa73..d70f69315 100644 --- a/docs/how-to/understanding-omnitrace-output.rst +++ b/docs/how-to/understanding-omnitrace-output.rst @@ -29,7 +29,7 @@ For example, starting with the following base configuration: [omnitrace] Outputting 'omnitrace-example-output/wall-clock.json'... If the ``OMNITRACE_USE_PID`` option is enabled, then running a non-MPI executable -with a PID of 63453 results in the following output: +with a PID of ``63453`` results in the following output: .. code-block:: shell @@ -252,7 +252,7 @@ Core configuration settings :widths: 30, 20, 100 "``OMNITRACE_OUTPUT_PATH``", "Any valid path", "Path to folder where output files should be placed" - "``OMNITRACE_OUTPUT_PREFIX``", "String", "Useful for multiple runs with different arguments. See the next section on output prefix keys" + "``OMNITRACE_OUTPUT_PREFIX``", "String", "Useful for multiple runs with different arguments. See the next section on output prefix keys." "``OMNITRACE_OUTPUT_FILE``", "Any valid filepath", "Specific location for the Perfetto output file" "``OMNITRACE_TIME_OUTPUT``", "Boolean", "Place all output in a timestamped folder, timestamp format controlled via ``OMNITRACE_TIME_FORMAT``" "``OMNITRACE_TIME_FORMAT``", "String", "See ``strftime`` man pages for valid identifiers" @@ -367,7 +367,7 @@ mode, so use this setting with caution. Timemory text output ----------------------------------------------------------------------- -Timemory text output files are meant for human-consumption (while JSON formats are for analysis), +Timemory text output files are meant for human consumption (while JSON formats are for analysis), so some fields such as the ``LABEL`` might be truncated for readability. The truncation settings be changed through the ``OMNITRACE_MAX_WIDTH`` setting.