[RFC,14/19] rtla: Add rtla osnoise man page

Commit Message

Daniel Bristot de Oliveira Sept. 17, 2021, 3:43 p.m. UTC

Man page for rtla osnoise command.

Cc: Steven Rostedt <[e-mail]>
Cc: Ingo Molnar <[e-mail]>
Cc: Tom Zanussi <[e-mail]>
Cc: Masami Hiramatsu <[e-mail]>
Cc: Juri Lelli <[e-mail]>
Cc: Clark Williams <[e-mail]>
Cc: Peter Zijlstra <[e-mail]>
Cc: Thomas Gleixner <[e-mail]>
Cc: Sebastian Andrzej Siewior <[e-mail]>
Cc: Daniel Bristot de Oliveira <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Signed-off-by: Daniel Bristot de Oliveira <[e-mail]>
---
 .../rtla/Documentation/rtla-osnoise.txt       | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 tools/tracing/rtla/Documentation/rtla-osnoise.txt

Patch

diff --git a/tools/tracing/rtla/Documentation/rtla-osnoise.txt b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
new file mode 100644
index 000000000000..2da49246b645
--- /dev/null
+++ b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
@@ -0,0 +1,68 @@ 
+rtla-osnoise(1)
+===============
+
+NAME
+----
+rtla-osnoise - Measure the operating system noise
+
+SYNOPSIS
+--------
+*rtla osnoise* [MODE] ...
+
+DESCRIPTION
+-----------
+The rtla-osnoise(1) tool is an interface for the osnoise tracer. The osnoise
+tracer dispatches a kernel thread per-cpu. These threads read the time in
+a loop while with preemption, softirqs and IRQs enabled, thus allowing all
+the sources of osnoise during its execution. The osnoise threads take note
+of the entry and exit point of any source of interferences, increasing a
+per-cpu interference counter. The osnoise tracer also saves an interference
+counter for each source of interference.
+
+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(1) mode
+display information about the periodic summary from the osnoise tracer.
+The rtla-osnoise-hist(1) mode display 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 <[e-mail]>
+
+REPORTING BUGS
+--------------
+Report bugs to <[e-mail]>
+
+LICENSE
+-------
+rtla is Free Software licensed under the GNU GPLv2
+
+COPYING
+-------
+Copyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).