From: Dhruva Gole <d-gole@ti.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: <linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
Dhruva Gole <d-gole@ti.com>
Subject: [PATCH] Documentation: index: Minor re-arrangement and improvements
Date: Thu, 4 Jan 2024 13:03:17 +0530 [thread overview]
Message-ID: <20240104073317.19709-1-d-gole@ti.com> (raw)
* 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@ti.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
next reply other threads:[~2024-01-04 7:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-04 7:33 Dhruva Gole [this message]
2024-01-23 21:51 ` [PATCH] Documentation: index: Minor re-arrangement and improvements Jonathan Corbet
2024-01-24 6:21 ` Dhruva Gole
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=20240104073317.19709-1-d-gole@ti.com \
--to=d-gole@ti.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