Skip to content

Commit 2eb4e66

Browse files
author
Jonathan Corbet
committed
docs: admin-guide: add some subsection headings
As part of the goal of bringing some order to this file, add subsection headings to help readers find what they are looking for. Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 42463d3 commit 2eb4e66

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Documentation/admin-guide/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ added to the kernel over time. There is, as yet, little overall order or
77
organization here — this material was not written to be a single, coherent
88
document! With luck things will improve quickly over time.
99

10+
General guides to kernel administration
11+
---------------------------------------
12+
1013
This initial section contains overall information, including the README
1114
file describing the kernel as a whole, documentation on kernel parameters,
1215
etc.
@@ -28,6 +31,9 @@ This section describes CPU vulnerabilities and their mitigations.
2831

2932
hw-vuln/index
3033

34+
Tracking down and identifying problems
35+
--------------------------------------
36+
3137
Here is a set of documents aimed at users who are trying to track down
3238
problems and bugs in particular.
3339

@@ -48,6 +54,9 @@ problems and bugs in particular.
4854
perf/index
4955
pstore-blk
5056

57+
sysfs
58+
-----
59+
5160
A big part of the kernel's administrative interface is the sysfs virtual
5261
filesystem; these documents describe how to interact with sysfs.
5362

@@ -57,6 +66,9 @@ filesystem; these documents describe how to interact with sysfs.
5766
sysfs-rules
5867
abi
5968

69+
Workload analysis
70+
-----------------
71+
6072
This is the beginning of a section with information of interest to
6173
application developers and system integrators doing analysis of the
6274
Linux kernel for safety critical applications. Documents supporting
@@ -68,6 +80,9 @@ subsystems expectations will be found here.
6880

6981
workload-tracing
7082

83+
Everything else
84+
---------------
85+
7186
The rest of this manual consists of various unordered guides on how to
7287
configure specific aspects of kernel behavior to your liking.
7388

0 commit comments

Comments
 (0)