Skip to content

Commit 941518d

Browse files
author
Jonathan Corbet
committed
docs: Hook the RTLA documents into the kernel docs build
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: d40d48e ("rtla: Add Documentation") Acked-by: Daniel Bristot de Oliveira <[email protected]> Acked-by: Steven Rostedt (Google) <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent e783362 commit 941518d

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

Documentation/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ to ReStructured Text format, or are simply too old.
166166
.. toctree::
167167
:maxdepth: 2
168168

169+
tools/index
169170
staging/index
170171
watch_queue
171172

Documentation/tools/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
============
4+
Kernel tools
5+
============
6+
7+
This book covers user-space tools that are shipped with the kernel source;
8+
more additions are needed here:
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
rtla/index
14+
15+
.. only:: subproject and html
16+
17+
Indices
18+
=======
19+
20+
* :ref:`genindex`

Documentation/tools/rtla/index.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
================================
4+
The realtime Linux analysis tool
5+
================================
6+
7+
RTLA provides a set of tools for the analysis of the kernel's realtime
8+
behavior on specific hardware.
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
rtla
14+
rtla-osnoise
15+
rtla-osnoise-hist
16+
rtla-osnoise-top
17+
rtla-timerlat
18+
rtla-timerlat-hist
19+
rtla-timerlat-top
20+
21+
.. only:: subproject and html
22+
23+
Indices
24+
=======
25+
26+
* :ref:`genindex`

0 commit comments

Comments
 (0)