Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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")
Acked-by: Daniel Bristot de Oliveira <bristot@kernel.org>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/877dau555q.fsf@meer.lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

+47
+1
Documentation/index.rst
··· 166 166 .. toctree:: 167 167 :maxdepth: 2 168 168 169 + tools/index 169 170 staging/index 170 171 watch_queue 171 172
+20
Documentation/tools/index.rst
··· 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`
+26
Documentation/tools/rtla/index.rst
··· 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`