diff options
author | Jonathan Corbet <corbet@lwn.net> | 2016-10-26 17:43:00 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-10-27 18:33:36 -0400 |
commit | b51208d41c6a4e7fc2f05e63df49f1834cd3c208 (patch) | |
tree | 610385aca3523b5e6aac8b54511f56c77345f544 /Documentation/index.rst | |
parent | 9e1f08607f904e89568e197f4e30985484a87fd7 (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.rst | 45 |
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 | ||
6 | Welcome to The Linux Kernel's documentation! | 6 | Welcome to The Linux Kernel's documentation |
7 | ============================================ | 7 | =========================================== |
8 | 8 | ||
9 | Contents: | 9 | This is the top level of the kernel's documentation tree. Kernel |
10 | documentation, like the kernel itself, is very much a work in progress; | ||
11 | that is especially true as we work to integrate our many scattered | ||
12 | documents into a coherent whole. Please note that improvements to the | ||
13 | documentation are welcome; join the linux-doc list at vger.kernel.org if | ||
14 | you want to help out. | ||
15 | |||
16 | User-oriented documentation | ||
17 | --------------------------- | ||
18 | |||
19 | The following manuals are written for *users* of the kernel — those who are | ||
20 | trying 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 | |
27 | Introduction to kernel development | ||
28 | ---------------------------------- | ||
29 | |||
30 | These manuals contain overall information about how to develop the kernel. | ||
31 | The kernel community is quite large, with thousands of developers | ||
32 | contributing over the course of a year. As with any large community, | ||
33 | knowing how things are done will make the process of getting your changes | ||
34 | merged 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 | |||
43 | Kernel API documentation | ||
44 | ------------------------ | ||
45 | |||
46 | These books get into the details of how specific kernel subsystems work | ||
47 | from the point of view of a kernel developer. Much of the information here | ||
48 | is taken directly from the kernel source, with supplemental material added | ||
49 | as needed (or at least as we managed to add it — probably *not* all that is | ||
50 | needed). | ||
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 |