* [PATCH] docs: add rtla documentation kernel docs index
@ 2022-01-31 20:11 Shuah Khan
2022-01-31 22:14 ` Shuah Khan
0 siblings, 1 reply; 2+ messages in thread
From: Shuah Khan @ 2022-01-31 20:11 UTC (permalink / raw)
To: corbet, rostedt, bristot; +Cc: Shuah Khan, linux-kernel, linux-doc
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.
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
---
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
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 2b4de3926858..3852b419fd68 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -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
-------------------
diff --git a/Documentation/tools/index.rst b/Documentation/tools/index.rst
new file mode 100644
index 000000000000..3352ec693596
--- /dev/null
+++ b/Documentation/tools/index.rst
@@ -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`
diff --git a/Documentation/tools/rtla/index.rst b/Documentation/tools/rtla/index.rst
new file mode 100644
index 000000000000..5aacc2e8113d
--- /dev/null
+++ b/Documentation/tools/rtla/index.rst
@@ -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`
--
2.32.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: add rtla documentation kernel docs index
2022-01-31 20:11 [PATCH] docs: add rtla documentation kernel docs index Shuah Khan
@ 2022-01-31 22:14 ` Shuah Khan
0 siblings, 0 replies; 2+ messages in thread
From: Shuah Khan @ 2022-01-31 22:14 UTC (permalink / raw)
To: corbet, rostedt, bristot; +Cc: linux-kernel, linux-doc, Shuah Khan
On 1/31/22 1:11 PM, Shuah Khan wrote:
> 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.
>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> ---
> 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 <corbet@lwn.net>
Date: Thu Jan 20 17:00:33 2022 -0700
docs: Hook the RTLA documents into the kernel docs build
thanks,
-- Shuah
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-01-31 22:14 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-31 20:11 [PATCH] docs: add rtla documentation kernel docs index Shuah Khan
2022-01-31 22:14 ` Shuah Khan
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).