Skip to content

Commit 0c7b436

Browse files
author
Jonathan Corbet
committed
docs: Rewrite the front page
The front page is the entry point to the documentation, especially for people who read it online. It's a big mess of everything we could think to toss into it. Rewrite the page with an eye toward simplicity and making it easy for readers to get going toward what they really want to find. This is only a beginning, but it makes our docs more approachable than before. Acked-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: David Vernet <void@manifault.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20220927160559.97154-3-corbet@lwn.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent 9d0f5cd commit 0c7b436

2 files changed

Lines changed: 110 additions & 96 deletions

File tree

Documentation/index.rst

Lines changed: 52 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -18,131 +18,88 @@ documents into a coherent whole. Please note that improvements to the
1818
documentation are welcome; join the linux-doc list at vger.kernel.org if
1919
you want to help out.
2020

21-
Licensing documentation
22-
-----------------------
21+
Working with the development community
22+
--------------------------------------
2323

24-
The following describes the license of the Linux kernel source code
25-
(GPLv2), how to properly mark the license of individual files in the source
26-
tree, as well as links to the full license text.
27-
28-
* :ref:`kernel_licensing`
29-
30-
User-oriented documentation
31-
---------------------------
32-
33-
The following manuals are written for *users* of the kernel — those who are
34-
trying to get it to work optimally on a given system.
24+
The essential guides for interacting with the kernel's development
25+
community and getting your work upstream.
3526

3627
.. toctree::
37-
:maxdepth: 2
38-
39-
admin-guide/index
40-
kbuild/index
41-
42-
Firmware-related documentation
43-
------------------------------
44-
The following holds information on the kernel's expectations regarding the
45-
platform firmwares.
28+
:maxdepth: 1
4629

47-
.. toctree::
48-
:maxdepth: 2
30+
process/development-process
31+
process/submitting-patches
32+
Code of conduct <process/code-of-conduct>
33+
maintainer/index
34+
All development-process docs <process/index>
4935

50-
firmware-guide/index
51-
devicetree/index
5236

53-
Application-developer documentation
54-
-----------------------------------
37+
Internal API manuals
38+
--------------------
5539

56-
The user-space API manual gathers together documents describing aspects of
57-
the kernel interface as seen by application developers.
40+
Manuals for use by developers working to interface with the rest of the
41+
kernel.
5842

5943
.. toctree::
60-
:maxdepth: 2
61-
62-
userspace-api/index
44+
:maxdepth: 1
6345

46+
core-api/index
47+
driver-api/index
48+
subsystem-apis
49+
Locking in the kernel <locking/index>
6450

65-
Introduction to kernel development
66-
----------------------------------
51+
Development tools and processes
52+
-------------------------------
6753

68-
These manuals contain overall information about how to develop the kernel.
69-
The kernel community is quite large, with thousands of developers
70-
contributing over the course of a year. As with any large community,
71-
knowing how things are done will make the process of getting your changes
72-
merged much easier.
54+
Various other manuals with useful information for all kernel developers.
7355

7456
.. toctree::
75-
:maxdepth: 2
57+
:maxdepth: 1
7658

77-
process/index
78-
dev-tools/index
59+
process/license-rules
7960
doc-guide/index
61+
dev-tools/index
62+
dev-tools/testing-overview
8063
kernel-hacking/index
8164
trace/index
82-
maintainer/index
8365
fault-injection/index
8466
livepatch/index
8567

8668

87-
Kernel API documentation
88-
------------------------
69+
User-oriented documentation
70+
---------------------------
8971

90-
These books get into the details of how specific kernel subsystems work
91-
from the point of view of a kernel developer. Much of the information here
92-
is taken directly from the kernel source, with supplemental material added
93-
as needed (or at least as we managed to add it — probably *not* all that is
94-
needed).
72+
The following manuals are written for *users* of the kernel — those who are
73+
trying to get it to work optimally on a given system and application
74+
developers seeking information on the kernel's user-space APIs.
9575

9676
.. toctree::
97-
:maxdepth: 2
77+
:maxdepth: 1
78+
79+
admin-guide/index
80+
The kernel build system <kbuild/index>
81+
admin-guide/reporting-issues.rst
82+
User-space tools <tools/index>
83+
userspace-api/index
84+
85+
86+
Firmware-related documentation
87+
------------------------------
88+
The following holds information on the kernel's expectations regarding the
89+
platform firmwares.
90+
91+
.. toctree::
92+
:maxdepth: 1
93+
94+
firmware-guide/index
95+
devicetree/index
9896

99-
driver-api/index
100-
core-api/index
101-
locking/index
102-
accounting/index
103-
block/index
104-
cdrom/index
105-
cpu-freq/index
106-
fb/index
107-
fpga/index
108-
hid/index
109-
i2c/index
110-
iio/index
111-
isdn/index
112-
infiniband/index
113-
leds/index
114-
netlabel/index
115-
networking/index
116-
pcmcia/index
117-
power/index
118-
target/index
119-
timers/index
120-
spi/index
121-
w1/index
122-
watchdog/index
123-
virt/index
124-
input/index
125-
hwmon/index
126-
gpu/index
127-
security/index
128-
sound/index
129-
crypto/index
130-
filesystems/index
131-
mm/index
132-
bpf/index
133-
usb/index
134-
PCI/index
135-
scsi/index
136-
misc-devices/index
137-
scheduler/index
138-
mhi/index
139-
peci/index
14097

14198
Architecture-agnostic documentation
14299
-----------------------------------
143100

144101
.. toctree::
145-
:maxdepth: 2
102+
:maxdepth: 1
146103

147104
asm-annotations
148105

@@ -163,9 +120,8 @@ of the documentation body, or may require some adjustments and/or conversion
163120
to ReStructured Text format, or are simply too old.
164121

165122
.. toctree::
166-
:maxdepth: 2
123+
:maxdepth: 1
167124

168-
tools/index
169125
staging/index
170126

171127

Documentation/subsystem-apis.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
==============================
4+
Kernel subsystem documentation
5+
==============================
6+
7+
These books get into the details of how specific kernel subsystems work
8+
from the point of view of a kernel developer. Much of the information here
9+
is taken directly from the kernel source, with supplemental material added
10+
as needed (or at least as we managed to add it — probably *not* all that is
11+
needed).
12+
13+
**Fixme**: much more organizational work is needed here.
14+
15+
.. toctree::
16+
:maxdepth: 1
17+
18+
driver-api/index
19+
core-api/index
20+
locking/index
21+
accounting/index
22+
block/index
23+
cdrom/index
24+
cpu-freq/index
25+
fb/index
26+
fpga/index
27+
hid/index
28+
i2c/index
29+
iio/index
30+
isdn/index
31+
infiniband/index
32+
leds/index
33+
netlabel/index
34+
networking/index
35+
pcmcia/index
36+
power/index
37+
target/index
38+
timers/index
39+
spi/index
40+
w1/index
41+
watchdog/index
42+
virt/index
43+
input/index
44+
hwmon/index
45+
gpu/index
46+
security/index
47+
sound/index
48+
crypto/index
49+
filesystems/index
50+
mm/index
51+
bpf/index
52+
usb/index
53+
PCI/index
54+
scsi/index
55+
misc-devices/index
56+
scheduler/index
57+
mhi/index
58+
peci/index

0 commit comments

Comments
 (0)