linux-toradex.git/Documentation/tools, branch v5.17-rc4

docs: Hook the RTLA documents into the kernel docs build

2022-01-27T18:20:39+00:00

The RTLA documents were added to Documentation/ but never hooked into the
rest of the docs build, leading to a bunch of warnings like:

  Documentation/tools/rtla/rtla-osnoise.rst: WARNING: document isn't included in any toctree

Add some basic glue to wire these documents into the build so that they are
available with the rest of the rendered docs.  No attempt has been made to
turn the RTLA docs into proper RST files rather than warmed-over man pages;
that is an exercise for the future.

Fixes: d40d48e1f1f2 ("rtla: Add Documentation")
Acked-by: Daniel Bristot de Oliveira 
Acked-by: Steven Rostedt (Google) 
Link: https://lore.kernel.org/r/877dau555q.fsf@meer.lwn.net
Signed-off-by: Jonathan Corbet

rtla: Add rtla timerlat hist documentation

2022-01-13T22:02:44+00:00

Man page for rtla timerlat hist mode.

Link: https://lkml.kernel.org/r/4a184003fdb81e23be3fe5ec882b1c89d5a95458.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add rtla timerlat top documentation

2022-01-13T22:02:43+00:00

Man page for rtla timerlat top mode.

Link: https://lkml.kernel.org/r/58c3d6212e6c6f1f012deb2e998dd082da92075f.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add rtla timerlat documentation

2022-01-13T22:02:43+00:00

Man page for rtla timerlat tool.

Link: https://lkml.kernel.org/r/78678b8d024bf5a3a79f831ac9441b96e8d2f56e.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add rtla osnoise hist documentation

2022-01-13T22:02:43+00:00

Man page for rtla osnoise hist mode.

Link: https://lkml.kernel.org/r/d43cc5d516b8db180575c4b66c4aa67c6a724a8d.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add rtla osnoise top documentation

2022-01-13T22:02:43+00:00

Man page for rtla osnoise top mode.

Link: https://lkml.kernel.org/r/445aa2173ca152fc2e68719e3c1a2547dd01efd3.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add rtla osnoise man page

2022-01-13T22:02:43+00:00

Man page for rtla osnoise command.

Link: https://lkml.kernel.org/r/304747c602e46f6396e3bb75dfdcb42ae3656dca.1639158831.git.bristot@kernel.org

Cc: Tao Zhou 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt

rtla: Add Documentation

2022-01-13T22:02:43+00:00

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 
Cc: Ingo Molnar 
Cc: Tom Zanussi 
Cc: Masami Hiramatsu 
Cc: Juri Lelli 
Cc: Clark Williams 
Cc: John Kacur 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: Sebastian Andrzej Siewior 
Cc: Daniel Bristot de Oliveira 
Cc: linux-rt-users@vger.kernel.org
Cc: linux-trace-devel@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Suggested-by: Steven Rostedt 
Suggested-by: Jonathan Corbet 
Signed-off-by: Daniel Bristot de Oliveira 
Signed-off-by: Steven Rostedt