diff mbox series

docs: consolidate core subsystems

Message ID 20230622071004.2934698-1-costa.shul@redhat.com
State New
Headers
Series docs: consolidate core subsystems |

Commit Message

Costa Shulyupin June 22, 2023, 7:10 a.m. UTC 
  to make the page more organized as requested

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
 Documentation/subsystem-apis.rst | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

Comments

Randy Dunlap June 22, 2023, 3:35 p.m. UTC | #1 
Hi--

On 6/22/23 00:10, Costa Shulyupin wrote:
> to make the page more organized as requested
> 
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> ---
>  Documentation/subsystem-apis.rst | 21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index b67a1b65855b..8664b05777c3 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -10,6 +10,20 @@ 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
> +   mm/index
> +   power/index
> +   scheduler/index
> +   timers/index
> +   locking/index
> +

In general I am OK with this grouping, except for 2 nits:

a. I'm not sure that locking is a subsystem (it's a core API IMO).

b. I often have trouble finding "filesystems" and I think that it should be
   given a higher location in the TOC (somehow).


thanks.
Costa Shulyupin June 22, 2023, 4:57 p.m. UTC | #2 
On Thu, 22 Jun 2023 at 18:36, Randy Dunlap <rdunlap@infradead.org> wrote:
> a. I'm not sure that locking is a subsystem (it's a core API IMO).
Actually https://docs.kernel.org/locking/index.html describes more
than just API.

> b. I often have trouble finding "filesystems" and I think that it should be
>    given a higher location in the TOC (somehow).
I plan to put "filesystems" under "Storage subsystems" in the next patch.

Thanks
Costa
Jonathan Corbet July 14, 2023, 7:38 p.m. UTC | #3 
Costa Shulyupin <costa.shul@redhat.com> writes:

> to make the page more organized as requested
>
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> ---
>  Documentation/subsystem-apis.rst | 21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)

Applied, thanks.

jon
diff mbox series

Patch

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index b67a1b65855b..8664b05777c3 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,6 +10,20 @@  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
+   mm/index
+   power/index
+   scheduler/index
+   timers/index
+   locking/index
+
 Human interfaces
 ----------------
 
@@ -39,9 +53,6 @@  Storage interfaces
 .. toctree::
    :maxdepth: 1
 
-   driver-api/index
-   core-api/index
-   locking/index
    accounting/index
    cpu-freq/index
    fpga/index
@@ -53,8 +64,6 @@  Storage interfaces
    netlabel/index
    networking/index
    pcmcia/index
-   power/index
-   timers/index
    spi/index
    w1/index
    watchdog/index
@@ -63,12 +72,10 @@  Storage interfaces
    accel/index
    security/index
    crypto/index
-   mm/index
    bpf/index
    usb/index
    PCI/index
    misc-devices/index
-   scheduler/index
    mhi/index
    peci/index
    wmi/index