summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2024-12-13 11:20:53 -0700
committerJonathan Corbet <corbet@lwn.net>2024-12-17 13:23:38 -0700
commit2eb4e66cddd7d2fd2bbb960f57d5e19435fa5290 (patch)
treea5a1e43dbf5e889aaba7482d8d3b69974d1765a1
parent42463d3e89ab09fb0c0ab0e8bce481bae2ef7159 (diff)
downloadlwn-2eb4e66cddd7d2fd2bbb960f57d5e19435fa5290.tar.gz
lwn-2eb4e66cddd7d2fd2bbb960f57d5e19435fa5290.zip
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 <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20241213182057.343527-3-corbet@lwn.net
-rw-r--r--Documentation/admin-guide/index.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 94b70bb203cc..6864b079b391 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -7,6 +7,9 @@ added to the kernel over time. There is, as yet, little overall order or
organization here — this material was not written to be a single, coherent
document! With luck things will improve quickly over time.
+General guides to kernel administration
+---------------------------------------
+
This initial section contains overall information, including the README
file describing the kernel as a whole, documentation on kernel parameters,
etc.
@@ -28,6 +31,9 @@ This section describes CPU vulnerabilities and their mitigations.
hw-vuln/index
+Tracking down and identifying problems
+--------------------------------------
+
Here is a set of documents aimed at users who are trying to track down
problems and bugs in particular.
@@ -48,6 +54,9 @@ problems and bugs in particular.
perf/index
pstore-blk
+sysfs
+-----
+
A big part of the kernel's administrative interface is the sysfs virtual
filesystem; these documents describe how to interact with sysfs.
@@ -57,6 +66,9 @@ filesystem; these documents describe how to interact with sysfs.
sysfs-rules
abi
+Workload analysis
+-----------------
+
This is the beginning of a section with information of interest to
application developers and system integrators doing analysis of the
Linux kernel for safety critical applications. Documents supporting
@@ -68,6 +80,9 @@ subsystems expectations will be found here.
workload-tracing
+Everything else
+---------------
+
The rest of this manual consists of various unordered guides on how to
configure specific aspects of kernel behavior to your liking.