milos-linux/Documentation/tools/rtla/rtla-osnoise.rst
Costa Shulyupin ba716ad46d Documentation/rtla: Convert links to RST format
Web links in the documentation are not properly displayed.

In the man pages web links look like:
  Osnoise tracer  documentation:  <  <https://www.kernel.org/doc/html/lat‐
  est/trace/osnoise-tracer.html> >

On web pages the URL caption is the URL itself.

Convert tracer documentation links to RST anonymous hyperlink format
for better rendering. Use newer docs.kernel.org instead of
www.kernel.org/doc/html/latest for brevity.

After the change, the links in the man pages look like:
  Osnoise tracer <https://docs.kernel.org/trace/osnoise-tracer.html>

On web pages the captions are the titles of the links.

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260405163847.3337981-1-costa.shul@redhat.com>
2026-04-09 08:23:12 -06:00

59 lines
1.4 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 <https://docs.kernel.org/trace/osnoise-tracer.html>`__
AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
.. include:: common_appendix.txt