linux-kernel - [PATCH 2/3] docs: admin-guide: add some subsection headings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20241213182057.343527-3-corbet@lwn.net>
Date: Fri, 13 Dec 2024 11:20:53 -0700
From: Jonathan Corbet <corbet@....net>
To: linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org,
	Jonathan Corbet <corbet@....net>
Subject: [PATCH 2/3] 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.

Signed-off-by: Jonathan Corbet <corbet@....net>
---
 Documentation/admin-guide/index.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

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.
 
-- 
2.47.1