summaryrefslogtreecommitdiffstats
path: root/Documentation/index.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-10-26 17:43:00 -0400
committerJonathan Corbet <corbet@lwn.net>2016-10-27 18:33:36 -0400
commitb51208d41c6a4e7fc2f05e63df49f1834cd3c208 (patch)
tree610385aca3523b5e6aac8b54511f56c77345f544 /Documentation/index.rst
parent9e1f08607f904e89568e197f4e30985484a87fd7 (diff)
docs: Tweak the top-level Sphinx page
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. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
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 f6a3d4766495..7cec8432ce7a 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -3,18 +3,55 @@
3 You can adapt this file completely to your liking, but it should at least 3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive. 4 contain the root `toctree` directive.
5 5
6Welcome to The Linux Kernel's documentation! 6Welcome to The Linux Kernel's documentation
7============================================ 7===========================================
8 8
9Contents: 9This is the top level of the kernel's documentation tree. Kernel
10documentation, like the kernel itself, is very much a work in progress;
11that is especially true as we work to integrate our many scattered
12documents into a coherent whole. Please note that improvements to the
13documentation are welcome; join the linux-doc list at vger.kernel.org if
14you want to help out.
15
16User-oriented documentation
17---------------------------
18
19The following manuals are written for *users* of the kernel — those who are
20trying to get it to work optimally on a given system.
10 21
11.. toctree:: 22.. toctree::
12 :maxdepth: 2 23 :maxdepth: 2
13 24
14 admin-guide/index 25 admin-guide/index
15 kernel-documentation 26
27Introduction to kernel development
28----------------------------------
29
30These manuals contain overall information about how to develop the kernel.
31The kernel community is quite large, with thousands of developers
32contributing over the course of a year. As with any large community,
33knowing how things are done will make the process of getting your changes
34merged much easier.
35
36.. toctree::
37 :maxdepth: 2
38
16 process/index 39 process/index
17 dev-tools/tools 40 dev-tools/tools
41 kernel-documentation
42
43Kernel API documentation
44------------------------
45
46These books get into the details of how specific kernel subsystems work
47from the point of view of a kernel developer. Much of the information here
48is taken directly from the kernel source, with supplemental material added
49as needed (or at least as we managed to add it — probably *not* all that is
50needed).
51
52.. toctree::
53 :maxdepth: 2
54
18 driver-api/index 55 driver-api/index
19 media/index 56 media/index
20 gpu/index 57 gpu/index