From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>,
Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 01/11] docs: Tweak the top-level Sphinx page
Date: Wed, 26 Oct 2016 17:19:29 -0600 [thread overview]
Message-ID: <1477523979-5837-2-git-send-email-corbet@lwn.net> (raw)
In-Reply-To: <1477523979-5837-1-git-send-email-corbet@lwn.net>
This will be the initial landing point for readers, so give them a bit of
introductory material. Also split the TOC into area-specific chunks to
make the whole thing a bit more approachable.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
Documentation/index.rst | 45 +++++++++++++++++++++++++++++++++++++++++----
1 file changed, 41 insertions(+), 4 deletions(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f6a3d4766495..7cec8432ce7a 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -3,18 +3,55 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to The Linux Kernel's documentation!
-============================================
+Welcome to The Linux Kernel's documentation
+===========================================
-Contents:
+This is the top level of the kernel's documentation tree. Kernel
+documentation, like the kernel itself, is very much a work in progress;
+that is especially true as we work to integrate our many scattered
+documents into a coherent whole. Please note that improvements to the
+documentation are welcome; join the linux-doc list at vger.kernel.org if
+you want to help out.
+
+User-oriented documentation
+---------------------------
+
+The following manuals are written for *users* of the kernel — those who are
+trying to get it to work optimally on a given system.
.. toctree::
:maxdepth: 2
admin-guide/index
- kernel-documentation
+
+Introduction to kernel development
+----------------------------------
+
+These manuals contain overall information about how to develop the kernel.
+The kernel community is quite large, with thousands of developers
+contributing over the course of a year. As with any large community,
+knowing how things are done will make the process of getting your changes
+merged much easier.
+
+.. toctree::
+ :maxdepth: 2
+
process/index
dev-tools/tools
+ kernel-documentation
+
+Kernel API documentation
+------------------------
+
+These books get into the details of how specific kernel subsystems work
+from the point of view of a kernel developer. Much of the information here
+is taken directly from the kernel source, with supplemental material added
+as needed (or at least as we managed to add it — probably *not* all that is
+needed).
+
+.. toctree::
+ :maxdepth: 2
+
driver-api/index
media/index
gpu/index
--
2.7.4
next prev parent reply other threads:[~2016-10-26 23:20 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-26 23:19 [PATCH 00/11] Organize and clean up the admin and process guides Jonathan Corbet
2016-10-26 23:19 ` Jonathan Corbet [this message]
2016-10-27 0:12 ` [PATCH 01/11] docs: Tweak the top-level Sphinx page Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 02/11] docs: retitle the kernel-documentation.rst Jonathan Corbet
2016-10-27 0:13 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 03/11] docs: Clean up and organize the admin guide a bit Jonathan Corbet
2016-10-27 0:18 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 04/11] docs: Get rid of the badRAM guide Jonathan Corbet
2016-10-27 0:19 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 05/11] docs: Get rid of the "basic profiling" guide Jonathan Corbet
2016-10-27 0:20 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 06/11] docs: Get rid of the "bug-hunting" guide Jonathan Corbet
2016-10-27 0:23 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 07/11] docs: Apply some basic organization to the process guide Jonathan Corbet
2016-10-27 0:24 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 08/11] docs: Tweak submitting-patches.rst formatting Jonathan Corbet
2016-10-27 0:25 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 09/11] docs: Collapse the process guide TOC Jonathan Corbet
2016-10-27 0:26 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 10/11] docs: add a warning to submitting-drivers.rst Jonathan Corbet
2016-10-27 0:38 ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 11/11] docs: Add a warning to applying-patches.rst Jonathan Corbet
2016-10-27 0:32 ` Mauro Carvalho Chehab
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=1477523979-5837-2-git-send-email-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@s-opensource.com \
/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®