linux-kernel - [PATCH] docs: remove tree links from the main index

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230718185156.1015753-1-costa.shul@redhat.com>
Date:   Tue, 18 Jul 2023 21:51:55 +0300
From:   Costa Shulyupin <costa.shul@...hat.com>
To:     Jonathan Corbet <corbet@....net>,
        linux-doc@...r.kernel.org (open list:DOCUMENTATION),
        linux-kernel@...r.kernel.org (open list)
Cc:     Costa Shulyupin <costa.shul@...hat.com>
Subject: [PATCH] docs: remove tree links from the main index

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@...hat.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