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)
Subject: [PATCH] docs: organize subsystems
Date: Wed, 31 May 2023 13:17:15 +0300 [thread overview]
Message-ID: <20230531101715.3256681-1-costa.shul@redhat.com> (raw)
In-Reply-To: <d1e4436e-b428-0f49-ecf1-079955aaecb2@gmail.com>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 2379 bytes --]
as requested.
Add classes:
* Core subsystems
* Storage interfaces
* Networking interfaces
* Peripherals interfaces
* Embedded interfaces
* Other subsystems
Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
Documentation/subsystem-apis.rst | 87 +++++++++++++++++++++++---------
1 file changed, 64 insertions(+), 23 deletions(-)
diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef..20655f6092c2 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,6 +10,22 @@ 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
+ driver-api/index
+ scheduler/index
+ timers/index
+ locking/index
+ cpu-freq/index
+ mm/index
+ power/index
+
+
Human interfaces
----------------
@@ -22,46 +38,71 @@ Human interfaces
gpu/index
fb/index
-**Fixme**: much more organizational work is needed here.
+
+Storage interfaces
+------------------
.. toctree::
:maxdepth: 1
- driver-api/index
- core-api/index
- locking/index
- accounting/index
+ filesystems/index
block/index
cdrom/index
- cpu-freq/index
- fpga/index
- i2c/index
- iio/index
+ scsi/index
+ target/index
+
+
+Networking interfaces
+---------------------
+
+.. toctree::
+ :maxdepth: 1
+
isdn/index
infiniband/index
- leds/index
netlabel/index
networking/index
- pcmcia/index
- power/index
- target/index
- timers/index
+ mhi/index
+
+
+Peripherals interfaces
+----------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ usb/index
+ PCI/index
+ hwmon/index
+ leds/index
+
+
+Embedded interfaces
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ fpga/index
+ i2c/index
+ iio/index
spi/index
w1/index
+ peci/index
+
+Other subsystems
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ accounting/index
+ pcmcia/index
watchdog/index
virt/index
- hwmon/index
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
--
2.40.1
next prev parent reply other threads:[~2023-05-31 10:20 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 ` Costa Shulyupin [this message]
2023-06-01 3:13 ` [PATCH] docs: organize subsystems Bagas Sanjaya
2023-06-01 14:55 ` [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems Costa Shulyupin
2023-06-01 16:28 ` 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=20230531101715.3256681-1-costa.shul@redhat.com \
--to=costa.shul@redhat.com \
--cc=bagasdotme@gmail.com \
--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).