linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Shuah Khan <skhan@linuxfoundation.org>
To: corbet@lwn.net, rostedt@goodmis.org, bristot@kernel.org
Cc: Shuah Khan <skhan@linuxfoundation.org>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] docs: add rtla documentation kernel docs index
Date: Mon, 31 Jan 2022 13:11:49 -0700	[thread overview]
Message-ID: <20220131201149.446609-1-skhan@linuxfoundation.org> (raw)

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


             reply	other threads:[~2022-01-31 20:12 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-31 20:11 Shuah Khan [this message]
2022-01-31 22:14 ` [PATCH] docs: add rtla documentation kernel docs index Shuah Khan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220131201149.446609-1-skhan@linuxfoundation.org \
    --to=skhan@linuxfoundation.org \
    --cc=bristot@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).