Skip to contentSkip to conversation

docs: Fix subsystem APIs page so ungrouped entries have their own header

PATCH Applied [email protected] 2 participants 2 messages Jan 25, 2024 – Jan 30, 2024 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Fix subsystem APIs page so ungrouped entries have their own header

From: Michael Kelley <[email protected]>

The kernel subsystem APIs front page currently has four top-level groupings with headers, and then everything else that isn't grouped. But in the table-of-contents, ungrouped subsystems are indented as if they were part of the preceding grouping (currently "Storage interfaces"), which is confusing.

Fix this by adding an "Other subsystems" header for the ungrouped subsystems.

Fixes 3c591cc954d5 ("docs: consolidate human interface subsystems")
---
 Documentation/subsystem-apis.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/subsystem-apis.rst +2 -0
index 2d353fb8ea26..74af50d2ef7f 100644
@@ -61,6 +61,8 @@ Storage interfaces
    scsi/index
    target/index
 
+Other subsystems
+----------------
 **Fixme**: much more organizational work is needed here.
 
 .. toctree::
Signature · 1 line
2.25.1
maintainer Applied
#1 lore raw
Quoted 8 lines · [email protected] writes:

From: Michael Kelley <[email protected]>

The kernel subsystem APIs front page currently has four top-level groupings with headers, and then everything else that isn't grouped. But in the table-of-contents, ungrouped subsystems are indented as if they were part of the preceding grouping (currently "Storage interfaces"), which is confusing.

Quoted 8 lines

Fix this by adding an "Other subsystems" header for the ungrouped subsystems.

Fixes 3c591cc954d5 ("docs: consolidate human interface subsystems")
---
 Documentation/subsystem-apis.rst | 2 ++
 1 file changed, 2 insertions(+)

Applied, thanks.

jon