mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-29 13:53:33 +00:00
d40d48e1f1
Adds the basis for rtla documentation. This patch also includes the rtla(1) man page. As suggested by Jonathan Corbet, we are placing these man pages at Documentation/tools/rtla, using rst format. It is not linked to the official documentation, though. The Makefile is based on bpftool's Documentation one. Link: https://lkml.kernel.org/r/5f510f3e962fc0cd531c43f5a815544dd720c3f2.1639158831.git.bristot@kernel.org Cc: Tao Zhou <tao.zhou@linux.dev> Cc: Ingo Molnar <mingo@redhat.com> Cc: Tom Zanussi <zanussi@kernel.org> Cc: Masami Hiramatsu <mhiramat@kernel.org> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Clark Williams <williams@redhat.com> Cc: John Kacur <jkacur@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Suggested-by: Steven Rostedt <rostedt@goodmis.org> Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
48 lines
979 B
ReStructuredText
48 lines
979 B
ReStructuredText
=========
|
|
rtla
|
|
=========
|
|
--------------------------------
|
|
Real-time Linux Analysis tool
|
|
--------------------------------
|
|
|
|
:Manual section: 1
|
|
|
|
SYNOPSIS
|
|
========
|
|
**rtla** *COMMAND* [*OPTIONS*]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
The **rtla** is a meta-tool that includes a set of commands that aims to
|
|
analyze the real-time properties of Linux. But instead of testing Linux
|
|
as a black box, **rtla** leverages kernel tracing capabilities to provide
|
|
precise information about the properties and root causes of unexpected
|
|
results.
|
|
|
|
COMMANDS
|
|
========
|
|
**osnoise**
|
|
|
|
Gives information about the operating system noise (osnoise).
|
|
|
|
**timerlat**
|
|
|
|
Measures the IRQ and thread timer latency.
|
|
|
|
OPTIONS
|
|
=======
|
|
**-h**, **--help**
|
|
|
|
Display the help text.
|
|
|
|
For other options, see the man page for the corresponding command.
|
|
|
|
SEE ALSO
|
|
========
|
|
**rtla-osnoise**\(1), **rtla-timerlat**\(1)
|
|
|
|
AUTHOR
|
|
======
|
|
Daniel Bristot de Oliveira <bristot@kernel.org>
|
|
|
|
.. include:: common_appendix.rst
|