[PATCH] Documentation: subsystem-apis: Categorize remaining subsystems

From: Costa Shulyupin
Date: Wed May 31 2023 - 06:17:15 EST


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@xxxxxxxxxx>
Link: https://lore.kernel.org/r/20230531101715.3256681-1-costa.shul@xxxxxxxxxx
[Bagas: rewrite patch description to be clearer and categorize a few more subsystems]
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
Documentation/subsystem-apis.rst | 123 ++++++++++++++++++++++---------
1 file changed, 88 insertions(+), 35 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef88..2c0b18a66e4e00 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
- hid/index
- sound/index
- gpu/index
fb/index
+ gpu/index
+ hid/index
+ input/index
+ sound/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
+ filesystems/index
+ pcmcia/index
+ scsi/index
+ target/index
+
+
+Networking
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ bpf/index
+ infiniband/index
+ isdn/index
+ mhi/index
+ netlabel/index
+ networking/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
- isdn/index
- infiniband/index
- leds/index
- netlabel/index
- networking/index
- pcmcia/index
- power/index
- target/index
- timers/index
+ peci/index
spi/index
w1/index
- watchdog/index
- virt/index
- hwmon/index
- accel/index
- security/index
+
+Integrity
+---------
+
+.. toctree::
+ :maxdepth: 1
+
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
+ security/index
+
+Virtualization
+--------------
+
+.. toctree::
+ :maxdepth: 1
+
+ virt/index
+
+Miscellaneous
+-------------
+
+.. toctree::
+ :maxdepth: 1
+
+ accel/index
+ accounting/index
+ watchdog/index
--
An old man doll... just what I always wanted! - Clara

Thanks.

--
An old man doll... just what I always wanted! - Clara