From: Costa Shulyupin <costa.shul@redhat.com>
To: Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org (open list:DOCUMENTATION),
linux-kernel@vger.kernel.org (open list)
Cc: Costa Shulyupin <costa.shul@redhat.com>
Subject: [PATCH] docs: remove tree links from the main index
Date: Tue, 18 Jul 2023 21:51:55 +0300 [thread overview]
Message-ID: <20230718185156.1015753-1-costa.shul@redhat.com> (raw)
and leave only their neighbor subsystem-apis
because these links are already listed under
section "Core subsystems" of Documentation/subsystem-apis.rst:
Core subsystems
---------------
.. toctree::
:maxdepth: 1
core-api/index
driver-api/index
mm/index
power/index
scheduler/index
timers/index
locking/index
Reference:
- https://www.kernel.org/doc/html/next/subsystem-apis.html#core-subsystems
Motivation:
- make the documentation more organized
- increase consistency, observability and maintainability
- improve balance of ToC tree by reducing overly populated lists
- avoid duplicate parallel links
- escape tangling of links
- intention to fit the main index into one page
Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
Documentation/index.rst | 3 ---
1 file changed, 3 deletions(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 9dfdc826618c..8d8b7eab1131 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -38,10 +38,7 @@ kernel.
.. toctree::
:maxdepth: 1
- core-api/index
- driver-api/index
subsystem-apis
- Locking in the kernel <locking/index>
Development tools and processes
===============================
--
2.41.0
next reply other threads:[~2023-07-18 18:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-18 18:51 Costa Shulyupin [this message]
2023-07-21 19:55 ` Jonathan Corbet
2023-07-22 2:21 ` Costa Shulyupin
2023-07-24 16:19 ` Jonathan Corbet
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=20230718185156.1015753-1-costa.shul@redhat.com \
--to=costa.shul@redhat.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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
all inboxes | Powered by JetHome®