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

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

[mhkelley58]

From: Michael Kelley <mhklinux@outlook.com>

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")
Signed-off-by: Michael Kelley <mhklinux@outlook.com>
---
 Documentation/subsystem-apis.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 2d353fb8ea26..74af50d2ef7f 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -61,6 +61,8 @@ Storage interfaces
    scsi/index
    target/index
 
+Other subsystems
+----------------
 **Fixme**: much more organizational work is needed here.
 
 .. toctree::
-- 
2.25.1

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

[Jonathan Corbet]

mhkelley58@gmail.com writes:

> From: Michael Kelley <mhklinux@outlook.com>
>
> 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")
> Signed-off-by: Michael Kelley <mhklinux@outlook.com>
> ---
>  Documentation/subsystem-apis.rst | 2 ++
>  1 file changed, 2 insertions(+)

Applied, thanks.

jon