linux-kernel - [PATCH] Documentation: index: Minor re-arrangement and improvements

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20240104073317.19709-1-d-gole@ti.com>
Date: Thu, 4 Jan 2024 13:03:17 +0530
From: Dhruva Gole <d-gole@...com>
To: Jonathan Corbet <corbet@....net>
CC: <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        Dhruva Gole
	<d-gole@...com>
Subject: [PATCH] Documentation: index: Minor re-arrangement and improvements

* It seems odd that a develper is forced to look at the licensing rules
  even before they get to the doc or coding guide.
  This belongs under the "Working with the development community" / "All
  development docs" page where it does reside even today.
* Rearrange the section for Internal API manuals to go lower because
  generally one would want to look at the tools and processes and admin
  guide pages first and then move onto something deeper like the API
  manuals.
* Reword the Dev tools section and title to something a bit more suitable.

Signed-off-by: Dhruva Gole <d-gole@...com>
---
 Documentation/index.rst | 34 ++++++++++++++++------------------
 1 file changed, 16 insertions(+), 18 deletions(-)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 36e61783437c..409eba0b9601 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -28,30 +28,14 @@ community and getting your work upstream.
    maintainer/index
    All development-process docs <process/index>
 
-
-Internal API manuals
-====================
-
-Manuals for use by developers working to interface with the rest of the
-kernel.
-
-.. toctree::
-   :maxdepth: 1
-
-   core-api/index
-   driver-api/index
-   subsystem-apis
-   Locking in the kernel <locking/index>
-
-Development tools and processes
+Development tools and resources
 ===============================
 
-Various other manuals with useful information for all kernel developers.
+Various tools and manuals with useful information for all kernel developers.
 
 .. toctree::
    :maxdepth: 1
 
-   process/license-rules
    doc-guide/index
    dev-tools/index
    dev-tools/testing-overview
@@ -81,6 +65,20 @@ developers seeking information on the kernel's user-space APIs.
 See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
 which are kept separately from the kernel's own documentation.
 
+Internal API manuals
+====================
+
+Manuals for use by developers working to interface with the rest of the
+kernel.
+
+.. toctree::
+   :maxdepth: 1
+
+   core-api/index
+   driver-api/index
+   subsystem-apis
+   Locking in the kernel <locking/index>
+
 Firmware-related documentation
 ==============================
 The following holds information on the kernel's expectations regarding the

base-commit: d0b3c8aa5e37775cd7c3ac07b256218df0fd6678
-- 
2.34.1