mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git
synced 2026-04-18 03:23:53 -04:00
96b546c241
Sphinx reports htmldocs errors:
Documentation/tools/rtla/common_options.rst:58: ERROR: Undefined substitution referenced: "threshold".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tool".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "thresharg".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tracer".
Documentation/tools/rtla/common_options.rst:92: ERROR: Undefined substitution referenced: "tracer".
Documentation/tools/rtla/common_options.rst:98: ERROR: Undefined substitution referenced: "actionsperf".
Documentation/tools/rtla/common_options.rst:113: ERROR: Undefined substitution referenced: "tool".
common_*.rst files are snippets that are intended to be included by rtla
docs (rtla*.rst). common_options.rst in particular contains
substitutions which depend on other common_* includes, so building it
independently as reST source results in above errors.
Rename all common_*.rst files to common_*.txt to prevent Sphinx from
building these snippets as standalone reST source and update all include
references accordingly.
Link: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
Suggested-by: Tomas Glozar <tglozar@redhat.com>
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
Reviewed-by: Tomas Glozar <tglozar@redhat.com>
Fixes: 05b7e10687 ("tools/rtla: Add remaining support for osnoise actions")
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20251008184522.13201-1-krishnagopi487@gmail.com
[Bagas: massage commit message and apply trailers]
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251013092719.30780-2-bagasdotme@gmail.com>
40 lines
1.2 KiB
Plaintext
40 lines
1.2 KiB
Plaintext
.. |threshold| replace:: **-a/--auto**, **-s/--stop**, or **-S/--stop-total**
|
|
.. |thresharg| replace:: -s
|
|
.. |tracer| replace:: osnoise
|
|
|
|
.. |actionsperf| replace::
|
|
Due to implementational limitations, actions might be delayed
|
|
up to one second after tracing is stopped.
|
|
|
|
**-a**, **--auto** *us*
|
|
|
|
Set the automatic trace mode. This mode sets some commonly used options
|
|
while debugging the system. It is equivalent to use **-s** *us* **-T 1 -t**.
|
|
|
|
**-p**, **--period** *us*
|
|
|
|
Set the *osnoise* tracer period in microseconds.
|
|
|
|
**-r**, **--runtime** *us*
|
|
|
|
Set the *osnoise* tracer runtime in microseconds.
|
|
|
|
**-s**, **--stop** *us*
|
|
|
|
Stop the trace if a single sample is higher than the argument in microseconds.
|
|
If **-T** is set, it will also save the trace to the output.
|
|
|
|
**-S**, **--stop-total** *us*
|
|
|
|
Stop the trace if the total sample is higher than the argument in microseconds.
|
|
If **-T** is set, it will also save the trace to the output.
|
|
|
|
**-T**, **--threshold** *us*
|
|
|
|
Specify the minimum delta between two time reads to be considered noise.
|
|
The default threshold is *5 us*.
|
|
|
|
**-t**, **--trace** \[*file*]
|
|
|
|
Save the stopped trace to [*file|osnoise_trace.txt*].
|