Skip to contentSkip to conversation

docs: add rtla documentation kernel docs index

PATCH In review Shuah Khan 1 participant 2 messages Jan 31, 2022

Subsystems (2)
lore
Share & tools
lore

Shuah Khan

author reviewer
#0 lore raw

PATCH 1/1 docs: add rtla documentation kernel docs index

Link rtla documentation to kernel docs. This patch adds index files under tools and rtla directories linking them to the kernel docs index.

This patch doesn't make any changes to the rtla Makefile and rtla files, hence no changes to rtla doc build and install.

---
 Documentation/index.rst            | 10 ++++++++++
 Documentation/tools/index.rst      | 17 +++++++++++++++++
 Documentation/tools/rtla/index.rst | 19 +++++++++++++++++++
 3 files changed, 46 insertions(+)
 create mode 100644 Documentation/tools/index.rst
 create mode 100644 Documentation/tools/rtla/index.rst
Documentation/index.rst +10 -0
index 2b4de3926858..3852b419fd68 100644
@@ -155,6 +155,16 @@ Architecture-specific documentation
 
    arch
 
+Linux kernel Tools documentation
+--------------------------------
+
+This is a collection user doucmentation for kernel tools that reside under
+the *tools* directory.
+
+.. toctree::
+   :maxdepth: 2
+
+   tools/index
 
 Other documentation
 -------------------
Documentation/tools/index.rst new file +17 -0
new file mode 100644
index 000000000000..3352ec693596
@@ -0,0 +1,17 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================================
+RTLA documentation and man-pages
+================================
+
+.. toctree::
+   :maxdepth: 2
+
+   rtla/index
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
Documentation/tools/rtla/index.rst new file +19 -0
new file mode 100644
index 000000000000..5aacc2e8113d
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. 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.32.0
author reviewer
#1 lore raw
Quoted 6 lines · Shuah Khan

Link rtla documentation to kernel docs. This patch adds index files under tools and rtla directories linking them to the kernel docs index.

This patch doesn't make any changes to the rtla Makefile and rtla files, hence no changes to rtla doc build and install.

Quoted 9 lines
---
  Documentation/index.rst            | 10 ++++++++++
  Documentation/tools/index.rst      | 17 +++++++++++++++++
  Documentation/tools/rtla/index.rst | 19 +++++++++++++++++++
  3 files changed, 46 insertions(+)

create mode 100644 Documentation/tools/index.rst create mode 100644 Documentation/tools/rtla/index.rst

Ignore this one as well. rc2 has the hook.

commit 941518d6538afa5ea0edc26e6c009d0b3163d422

Author: Jonathan Corbet <[email protected]>
Date:   Thu Jan 20 17:00:33 2022 -0700

docs: Hook the RTLA documents into the kernel docs build

thanks,
-- Shuah