mirror of
https://github.com/torvalds/linux.git
synced 2025-12-07 20:06:24 +00: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>
60 lines
1.5 KiB
ReStructuredText
60 lines
1.5 KiB
ReStructuredText
===============
|
|
rtla-osnoise
|
|
===============
|
|
------------------------------------------------------------------
|
|
Measure the operating system noise
|
|
------------------------------------------------------------------
|
|
|
|
:Manual section: 1
|
|
|
|
SYNOPSIS
|
|
========
|
|
**rtla osnoise** [*MODE*] ...
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
.. include:: common_osnoise_description.txt
|
|
|
|
The *osnoise* tracer outputs information in two ways. It periodically prints
|
|
a summary of the noise of the operating system, including the counters of
|
|
the occurrence of the source of interference. It also provides information
|
|
for each noise via the **osnoise:** tracepoints. The **rtla osnoise top**
|
|
mode displays information about the periodic summary from the *osnoise* tracer.
|
|
The **rtla osnoise hist** mode displays information about the noise using
|
|
the **osnoise:** tracepoints. For further details, please refer to the
|
|
respective man page.
|
|
|
|
MODES
|
|
=====
|
|
**top**
|
|
|
|
Prints the summary from osnoise tracer.
|
|
|
|
**hist**
|
|
|
|
Prints a histogram of osnoise samples.
|
|
|
|
If no MODE is given, the top mode is called, passing the arguments.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
**-h**, **--help**
|
|
|
|
Display the help text.
|
|
|
|
For other options, see the man page for the corresponding mode.
|
|
|
|
SEE ALSO
|
|
========
|
|
**rtla-osnoise-top**\(1), **rtla-osnoise-hist**\(1)
|
|
|
|
Osnoise tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
|
|
|
|
AUTHOR
|
|
======
|
|
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
|
|
|
|
.. include:: common_appendix.txt
|