Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
+41
-4
+41
-4
Documentation/index.rst
+41
-4
Documentation/index.rst
···
3
3
You can adapt this file completely to your liking, but it should at least
4
4
contain the root `toctree` directive.
5
5
6
-
Welcome to The Linux Kernel's documentation!
7
-
============================================
6
+
Welcome to The Linux Kernel's documentation
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
22
.. toctree::
12
23
:maxdepth: 2
13
24
14
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
39
process/index
17
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
55
driver-api/index
19
56
media/index
20
57
gpu/index