summaryrefslogtreecommitdiffstats
path: root/Documentation/index.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-10-27 17:05:10 -0600
committerJonathan Corbet <corbet@lwn.net>2016-10-27 17:47:58 -0600
commit9d2cccdd6c226181c42a7bb0c5ede1583687b618 (patch)
tree993ff17c35fd23a71533e63f6943b9bf59e1d5e4 /Documentation/index.rst
parent2797cd03f5cca4d9fb2875c9f9c995737ce73469 (diff)
parent67972a539e9ff1a3ed794c463c4e544442df693e (diff)
downloadlinux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.tar.gz
linux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.tar.bz2
linux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.zip
Merge branch 'doc-tweaks' into docs-next
The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
Diffstat (limited to 'Documentation/index.rst')
-rw-r--r--Documentation/index.rst45
1 files changed, 41 insertions, 4 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 0f98823126f2..85a66270f96c 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/index
+ 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