Skip to contentSkip to conversation

docs: Hook the RTLA documents into the kernel docs build

PATCH In review Jonathan Corbet 3 participants 3 messages Jan 21, 2022 – Jan 25, 2022

Subsystems (2)
lore
Share & tools
lore

Jonathan Corbet

author maintainer
#0 lore raw

PATCH 1/1 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 d40d48e1f1f2 ("rtla: Add Documentation")

---
I'm happy to see this follow the original via the tracing tree, or I can send it Linusward myself once docs-next catches up with mainline.

 Documentation/index.rst            |  1 +
 Documentation/tools/index.rst      | 18 ++++++++++++++++++
 Documentation/tools/rtla/index.rst | 24 ++++++++++++++++++++++++
 3 files changed, 43 insertions(+)
 create mode 100644 Documentation/tools/index.rst
 create mode 100644 Documentation/tools/rtla/index.rst
Documentation/index.rst +1 -0
index 2b4de3926858..b58692d687f6 100644
@@ -166,6 +166,7 @@ to ReStructured Text format, or are simply too old.
 .. toctree::
    :maxdepth: 2
 
+   tools/index
    staging/index
    watch_queue
 
Documentation/tools/index.rst new file +18 -0
new file mode 100644
index 000000000000..18f5f4583996
@@ -0,0 +1,18 @@
+============
+Kernel tools
+============
+
+This book covers user-space tools that are shipped with the kernel source;
+more additions are needed here:
+
+.. toctree::
+   :maxdepth: 1
+
+   rtla/index
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
Documentation/tools/rtla/index.rst new file +24 -0
new file mode 100644
index 000000000000..5938009bf4ae
@@ -0,0 +1,24 @@
+================================
+The realtime Linux analysis tool
+================================
+
+RTLA provides a set of tools for the analysis of the kernel's realtime
+behavior on specific hardware.
+
+.. toctree::
+   :maxdepth: 1
+
+   rtla
+   rtla-osnoise
+   rtla-osnoise-hist
+   rtla-osnoise-top
+   rtla-timerlat
+   rtla-timerlat-hist
+   rtla-timerlat-top
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
Signature · 1 line
2.34.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 9 lines · On Thu, 20 Jan 2022 17:00:33 -0700 Jonathan Corbet <[email protected]> wrote:

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.

Looks fine to me.

-- Steve

Acked-by on v1 1/1
#2 lore raw
In reply to Jonathan Corbet
Quoted 5 lines · Jonathan Corbet

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

Quoted 7 lines

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")

Thanks, Jon!

-- Daniel