[2/3] docs: consolidate peripheral interfaces

Message ID 20230715165759.74901-1-costa.shul@redhat.com
State New
Headers
Series [1/3] docs: consolidate networking interfaces |

Commit Message

Costa Shulyupin July 15, 2023, 4:57 p.m. UTC
  to make the page more organized as requested

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

Comments

Jonathan Corbet July 21, 2023, 8:58 p.m. UTC | #1
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 | 15 +++++++++++----
>  1 file changed, 11 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index 90a0535a932a..7b086c89e2be 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -48,6 +48,17 @@ Networking interfaces
>     isdn/index
>     mhi/index
>  
> +Peripheral interfaces
> +----------------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   usb/index
> +   PCI/index
> +   hwmon/index
> +   leds/index
> +
>  Storage interfaces
>  ------------------
>  
> @@ -70,19 +81,15 @@ Storage interfaces
>     fpga/index
>     i2c/index
>     iio/index
> -   leds/index
>     pcmcia/index
>     spi/index
>     w1/index
>     watchdog/index
>     virt/index
> -   hwmon/index
>     accel/index
>     security/index
>     crypto/index
>     bpf/index
> -   usb/index
> -   PCI/index
>     misc-devices/index
>     peci/index
>     wmi/index

So this one seems a bit less well thought out.  How are you defining
"peripheral interface"?  How is it that PCI qualifies but, say, PCMCIA
does not?  In a real sense, most of our interfaces deal with peripherals
in one way or another.

Were you thinking maybe of "bus interfaces"?  If so, a somewhat
different selection would be indicated.

Thanks,

jon
  

Patch

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 90a0535a932a..7b086c89e2be 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -48,6 +48,17 @@  Networking interfaces
    isdn/index
    mhi/index
 
+Peripheral interfaces
+----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   usb/index
+   PCI/index
+   hwmon/index
+   leds/index
+
 Storage interfaces
 ------------------
 
@@ -70,19 +81,15 @@  Storage interfaces
    fpga/index
    i2c/index
    iio/index
-   leds/index
    pcmcia/index
    spi/index
    w1/index
    watchdog/index
    virt/index
-   hwmon/index
    accel/index
    security/index
    crypto/index
    bpf/index
-   usb/index
-   PCI/index
    misc-devices/index
    peci/index
    wmi/index