Skip to content

Commit

Permalink
Add .gitignore for Doxygen and remove deprecated words and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
amd-jnovotny committed Jul 2, 2024
1 parent 446c58b commit 6b053dd
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/conceptual/how-omnitrace-works.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ when instrumenting Python.
limited to only the functions defined in the binary. This is also known as **Binary rewrite**.

**Dynamic binary instrumentation**
Loads an existing binary into memory, inserts instrumentation, and executes the binary.
Loads an existing binary into memory, inserts instrumentation, and runs the binary.
It is limited to executables but is capable of instrumenting linked libraries.
This is also known as: **Runtime instrumentation**.

Expand Down Expand Up @@ -204,7 +204,7 @@ changes which might, in some cases, lead to inaccurate results. The effect depen
the information being collected and which features are activated in Omnitrace.
For example, collecting only the wall-clock timing data
has less of an effect than collecting the wall-clock timing, CPU-clock timing,
memory usage, cache-misses, and number of instructions executed. Similarly,
memory usage, cache-misses, and number of instructions that were run. Similarly,
collecting a flat profile has less overhead than a hierarchical profile
and collecting a trace OR a profile has less overhead than collecting a
trace AND a profile.
Expand Down
3 changes: 3 additions & 0 deletions docs/doxygen/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
html/
latex/
xml/
2 changes: 1 addition & 1 deletion docs/how-to/configuring-runtime-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ For example, the following is a valid configuration:
OMNITRACE_PAPI_EVENTS = perf::INSTRUCTIONS perf::CACHE-REFERENCES perf::CACHE-MISSES
However, the following specification of a roughly equivalent set of hardware counters is an invalid configuration because it mixes
However, the following specification of a roughly equivalent set of hardware counters is an incorrect configuration because it mixes
PAPI components from different namespaces:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/instrumenting-rewriting-binary-application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@ By default, ``omnitrace-instrument`` uses ``--mode trace`` for instrumentation.
only instruments ``main`` in an executable. It activates both CPU call-stack sampling and
background system-level thread sampling by default.
Tracing capabilities which do not rely on instrumentation, such as the HIP API and kernel tracing
(which is collected vbyia roctracer), are still available.
(which is collected by roctracer), are still available.
The Omnitrace sampling capabilities are always available, even in trace mode, but are deactivated by default.
To activate sampling in trace mode, set ``OMNITRACE_USE_SAMPLING=ON`` in the environment
Expand Down
8 changes: 4 additions & 4 deletions docs/how-to/performing-causal-profiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Performing causal profiling

The process of causal profiling can be summarized as:

*If you speed up a given block of code by X%, the application will execute Y% faster*.
*If you speed up a given block of code by X%, the application will run Y% faster*.

Causal profiling directs parallel application developers to where they should focus their optimization
efforts by quantifying the potential impact of optimizations. Causal profiling is rooted in the concept
Expand Down Expand Up @@ -57,7 +57,7 @@ because the end-to-end performance is limited by ``bar``. However, a 5% speed-up
in ``bar`` will result 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`` executes as fast as ``foo``.
end-to-end performance, and so on, up to a 30% speed-up, at which point ``bar`` runs as fast as ``foo``.
Any speed-up to ``bar`` beyond 30% still only yields an end-to-end performance
improvement of 30% because the application
is now limited by performance of ``foo``, as demonstrated below in the causal
Expand Down Expand Up @@ -94,7 +94,7 @@ This can happen in three different ways:
.. note::

Binary rewrite to insert progress points is not supported. When a rewritten binary
is executed, Dyninst translates the instruction pointer address in order to perform
runs, Dyninst translates the instruction pointer address in order to perform
the instrumentation. As a result, call stack samples never return instruction
pointer addresses within the valid Omnitrace range.

Expand Down Expand Up @@ -183,7 +183,7 @@ If this file does not exist, as with Debian-based systems like Ubuntu, run the f
and reboot your computer. In order to use the ``perf`` backend, the value
of ``/proc/sys/kernel/perf_event_paranoid``
should be <= 2. If the value in this file is greater than 2, you can't
should be less than or equal to 2. If the value in this file is greater than 2, you can't
use the ``perf`` backend.

To update the paranoid level temporarily until the system is rebooted, run
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/understanding-omnitrace-output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Understanding the Omnitrace output
The general output form of `Omnitrace <https://github.com/ROCm/omnitrace>`_ is
``<OUTPUT_PATH>[/<TIMESTAMP>]/[<PREFIX>]<DATA_NAME>[-<OUTPUT_SUFFIX>].<EXT>``.

For example, starting with thefollowing base configuration:
For example, starting with the following base configuration:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/development-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ and roctracer directly invoke
calls to Perfetto or timemory's storage model. Otherwise, the data is stored
by Omnitrace in the thread-data model
which is more persistent than simply using ``thread_local`` static data, which gets deleted
when the thread terminates.
when the thread stops.

Thread identification
--------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/what-is-omnitrace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ and visualization in Jupyter notebooks.
To use Omnitrace for instrumentation, follow these two configuration steps:

#. Indicate the functions and modules to :doc:`instrument <./how-to/instrumenting-rewriting-binary-application>` in the target binaries, including the executable and any libraries
#. Specify the :doc:`type of instrumentation <./how-to/configuring-runtime-options>` to perform when the instrumented binaries are executed
#. Specify the :doc:`type of instrumentation <./how-to/configuring-runtime-options>` to perform when the instrumented binaries are launched

0 comments on commit 6b053dd

Please sign in to comment.