Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Costa Shulyupin <costa.shul@redhat.com>
To:     Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     Costa Shulyupin <costa.shul@redhat.com>,
        linux-kernel@vger.kernel.org (open list),
        bpf@vger.kernel.org (open list:BPF [MISC])
Subject: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
Date:   Thu,  1 Jun 2023 17:55:55 +0300
Message-Id: <20230601145556.3927838-1-costa.shul@redhat.com>
In-Reply-To: <ZHgM0qKWP3OusjUW@debian.me>
References: <ZHgM0qKWP3OusjUW@debian.me>
MIME-Version: 1.0
Content-Type: text/plain; charset=true
Content-Transfer-Encoding: 8bit
Precedence: bulk

From: Bagas Sanjaya <bagasdotme@gmail.com>

Add classes:
* Core subsystems
* Storage
* Networking
* Peripherals and devices
* Embedded systems
* Integrity
* Virtualization
* Miscellaneous

There is a FIXME that says to organize subsystems listed in
subsystem-apis.rst. Fulfill it by categorize remaining subsytems
by purpose/themes, while sorting entries in each category.

HID devices are already categorized in 3c591cc954d56e ("docs:
consolidate human interface subsystems").

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>

---

Changes:
v3: add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
v2: add Core subsystems, Networking, Peripherals and Embedded
v1: add Storgre category
---
 Documentation/subsystem-apis.rst | 119 ++++++++++++++++++++++---------
 1 file changed, 86 insertions(+), 33 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef..2c0b18a66e4e 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,58 +10,111 @@ is taken directly from the kernel source, with supplemental material added
 as needed (or at least as we managed to add it — probably *not* all that is
 needed).
 
+Core subsystems
+---------------
+
+.. toctree::
+   :maxdepth: 1
+
+   core-api/index
+   cpu-freq/index
+   driver-api/index
+   locking/index
+   mm/index
+   power/index
+   scheduler/index
+   timers/index
+   wmi/index
+
 Human interfaces
 ----------------
 
 .. toctree::
    :maxdepth: 1
 
-   input/index
+   fb/index
+   gpu/index
    hid/index
+   input/index
    sound/index
-   gpu/index
-   fb/index
 
-**Fixme**: much more organizational work is needed here.
+Storage
+-------
 
 .. toctree::
    :maxdepth: 1
 
-   driver-api/index
-   core-api/index
-   locking/index
-   accounting/index
    block/index
    cdrom/index
-   cpu-freq/index
-   fpga/index
-   i2c/index
-   iio/index
-   isdn/index
+   filesystems/index
+   pcmcia/index
+   scsi/index
+   target/index
+
+
+Networking
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   bpf/index
    infiniband/index
-   leds/index
+   isdn/index
+   mhi/index
    netlabel/index
    networking/index
-   pcmcia/index
-   power/index
-   target/index
-   timers/index
+
+
+Peripherals and devices
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   PCI/index
+   hwmon/index
+   leds/index
+   misc-devices/index
+   usb/index
+
+
+Embedded systems
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   fpga/index
+   i2c/index
+   iio/index
+   peci/index
    spi/index
    w1/index
-   watchdog/index
+
+Integrity
+---------
+
+.. toctree::
+   :maxdepth: 1
+
+   crypto/index
+   security/index
+
+Virtualization
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
    virt/index
-   hwmon/index
+
+Miscellaneous
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
    accel/index
-   security/index
-   crypto/index
-   filesystems/index
-   mm/index
-   bpf/index
-   usb/index
-   PCI/index
-   scsi/index
-   misc-devices/index
-   scheduler/index
-   mhi/index
-   peci/index
-   wmi/index
+   accounting/index
+   watchdog/index
-- 
2.40.1