linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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	[thread overview]
Message-ID: <20230601145556.3927838-1-costa.shul@redhat.com> (raw)
In-Reply-To: <ZHgM0qKWP3OusjUW@debian.me>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 3150 bytes --]

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


  reply	other threads:[~2023-06-01 14:56 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-29  8:55 [PATCH] docs: consolidate storage interfaces Costa Shulyupin
2023-05-30  8:54 ` Bagas Sanjaya
2023-05-31 10:17   ` [PATCH] docs: organize subsystems Costa Shulyupin
2023-06-01  3:13     ` Bagas Sanjaya
2023-06-01 14:55       ` Costa Shulyupin [this message]
2023-06-01 16:28         ` [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems Randy Dunlap
2023-06-02 10:08         ` Bagas Sanjaya
2023-06-02 10:19           ` Jonathan Corbet
2023-06-02 12:33             ` Bagas Sanjaya
2023-06-09  8:05         ` Jonathan Corbet
2023-06-18  6:29           ` [PATCH v4] docs: consolidate storage interfaces Costa Shulyupin
2023-06-18 15:19             ` Randy Dunlap
2023-06-18 16:09               ` Costa Shulyupin
2023-06-21 15:33             ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230601145556.3927838-1-costa.shul@redhat.com \
    --to=costa.shul@redhat.com \
    --cc=bagasdotme@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).