Skip to content

Commit 270beb5

Browse files
author
Jonathan Corbet
committed
docs: admin-guide: bring some order to the "everything else" section
The bulk of the admin guide had become a big pile of stuff haphazardly tossed together, mostly in the catch-all "everything else" section. Split that section into a few broad categories and sort the documents into them as appropriate. No documents have been added or removed, they are just reordered. Note that many of these documents are severely obsolete and should be considered for removal. Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 2eb4e66 commit 270beb5

File tree

1 file changed

+100
-61
lines changed

1 file changed

+100
-61
lines changed

Documentation/admin-guide/index.rst

Lines changed: 100 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,41 @@ etc.
1818
:maxdepth: 1
1919

2020
README
21-
kernel-parameters
2221
devices
23-
sysctl/index
2422

2523
features
2624

27-
This section describes CPU vulnerabilities and their mitigations.
25+
A big part of the kernel's administrative interface is the /proc and sysfs
26+
virtual filesystems; these documents describe how to interact with tem
27+
28+
.. toctree::
29+
:maxdepth: 1
30+
31+
sysfs-rules
32+
sysctl/index
33+
cputopology
34+
abi
35+
36+
Security-related documentation:
2837

2938
.. toctree::
3039
:maxdepth: 1
3140

3241
hw-vuln/index
42+
LSM/index
43+
perf-security
44+
45+
Booting the kernel
46+
------------------
47+
48+
.. toctree::
49+
:maxdepth: 1
50+
51+
bootconfig
52+
kernel-parameters
53+
efi-stub
54+
initrd
55+
3356

3457
Tracking down and identifying problems
3558
--------------------------------------
@@ -53,104 +76,120 @@ problems and bugs in particular.
5376
kdump/index
5477
perf/index
5578
pstore-blk
79+
clearing-warn-once
80+
kernel-per-CPU-kthreads
81+
lockup-watchdogs
82+
RAS/index
83+
sysrq
84+
5685

57-
sysfs
58-
-----
86+
Core-kernel subsystems
87+
----------------------
5988

60-
A big part of the kernel's administrative interface is the sysfs virtual
61-
filesystem; these documents describe how to interact with sysfs.
89+
These documents describe core-kernel administration interfaces that are
90+
likely to be of interest on almost any system.
6291

6392
.. toctree::
6493
:maxdepth: 1
6594

66-
sysfs-rules
67-
abi
68-
69-
Workload analysis
70-
-----------------
95+
cgroup-v2
96+
cgroup-v1/index
97+
cpu-load
98+
mm/index
99+
module-signing
100+
namespaces/index
101+
numastat
102+
pm/index
103+
syscall-user-dispatch
71104

72-
This is the beginning of a section with information of interest to
73-
application developers and system integrators doing analysis of the
74-
Linux kernel for safety critical applications. Documents supporting
75-
analysis of kernel interactions with applications, and key kernel
76-
subsystems expectations will be found here.
105+
Support for non-native binary formats. Note that some of these
106+
documents are ... old ...
77107

78108
.. toctree::
79109
:maxdepth: 1
80110

81-
workload-tracing
111+
binfmt-misc
112+
java
113+
mono
82114

83-
Everything else
84-
---------------
85115

86-
The rest of this manual consists of various unordered guides on how to
87-
configure specific aspects of kernel behavior to your liking.
116+
Block-layer and filesystem administration
117+
-----------------------------------------
88118

89119
.. toctree::
90120
:maxdepth: 1
91121

92-
acpi/index
93-
aoe/index
94-
auxdisplay/index
95122
bcache
96123
binderfs
97-
binfmt-misc
98124
blockdev/index
99-
bootconfig
100-
braille-console
101-
btmrvl
102-
cgroup-v1/index
103-
cgroup-v2
104125
cifs/index
105-
clearing-warn-once
106-
cpu-load
107-
cputopology
108-
dell_rbu
109126
device-mapper/index
110-
edid
111-
efi-stub
112127
ext4
113128
filesystem-monitoring
114129
nfs/index
115-
gpio/index
116-
highuid
117-
hw_random
118-
initrd
119130
iostats
120-
java
121131
jfs
122-
kernel-per-CPU-kthreads
132+
md
133+
ufs
134+
xfs
135+
136+
Device-specific guides
137+
----------------------
138+
139+
How to configure your hardware within your Linux system.
140+
141+
.. toctree::
142+
:maxdepth: 1
143+
144+
acpi/index
145+
aoe/index
146+
auxdisplay/index
147+
braille-console
148+
btmrvl
149+
dell_rbu
150+
edid
151+
gpio/index
152+
hw_random
123153
laptops/index
124154
lcd-panel-cgram
125-
ldm
126-
lockup-watchdogs
127-
LSM/index
128-
md
129155
media/index
130-
mm/index
131-
module-signing
132-
mono
133-
namespaces/index
134-
numastat
156+
nvme-multipath
135157
parport
136-
perf-security
137-
pm/index
138158
pnp
139159
rapidio
140-
RAS/index
141160
rtc
142161
serial-console
143162
svga
144-
syscall-user-dispatch
145-
sysrq
146163
thermal/index
147164
thunderbolt
148-
ufs
149-
unicode
150165
vga-softcursor
151166
video-output
152-
xfs
153-
nvme-multipath
167+
168+
Workload analysis
169+
-----------------
170+
171+
This is the beginning of a section with information of interest to
172+
application developers and system integrators doing analysis of the
173+
Linux kernel for safety critical applications. Documents supporting
174+
analysis of kernel interactions with applications, and key kernel
175+
subsystems expectations will be found here.
176+
177+
.. toctree::
178+
:maxdepth: 1
179+
180+
workload-tracing
181+
182+
Everything else
183+
---------------
184+
185+
A few hard-to-categorize and generally obsolete documents.
186+
187+
.. toctree::
188+
:maxdepth: 1
189+
190+
highuid
191+
ldm
192+
unicode
154193

155194
.. only:: subproject and html
156195

0 commit comments

Comments
 (0)