[PATCH] docs: consolidate embedded interfaces

[PATCH] docs: consolidate embedded interfaces

[Costa Shulyupin]

to make page Subsystems APIs 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 90a0535a932a..7453586114d4 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -60,20 +60,28 @@ Storage interfaces
    scsi/index
    target/index
 
-**Fixme**: much more organizational work is needed here.
+Embedded interfaces
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   iio/index
+   spi/index
+   i2c/index
+   fpga/index
+   w1/index
+   misc-devices/index
+
+**Fixme**: some organizational work is still needed here.
 
 .. toctree::
    :maxdepth: 1
 
    accounting/index
    cpu-freq/index
-   fpga/index
-   i2c/index
-   iio/index
    leds/index
    pcmcia/index
-   spi/index
-   w1/index
    watchdog/index
    virt/index
    hwmon/index
@@ -83,6 +91,5 @@ Storage interfaces
    bpf/index
    usb/index
    PCI/index
-   misc-devices/index
    peci/index
    wmi/index
-- 
2.41.0

Re: [PATCH] docs: consolidate embedded interfaces

[Jonathan Corbet]

Costa Shulyupin <costa.shul@redhat.com> writes:

> soft reminder 

I thought I was clear...I still don't see how this organization makes
sense.  What is "embedded" about misc devices?

Thanks,

jon

> On Tue, 25 Jul 2023 at 16:56, Costa Shulyupin <costa.shul@redhat.com> wrote:
>
>  to make page Subsystems APIs 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 90a0535a932a..7453586114d4 100644
>  --- a/Documentation/subsystem-apis.rst
>  +++ b/Documentation/subsystem-apis.rst
>  @@ -60,20 +60,28 @@ Storage interfaces
>      scsi/index
>      target/index
>
>  -**Fixme**: much more organizational work is needed here.
>  +Embedded interfaces
>  +-------------------
>  +
>  +.. toctree::
>  +   :maxdepth: 1
>  +
>  +   iio/index
>  +   spi/index
>  +   i2c/index
>  +   fpga/index
>  +   w1/index
>  +   misc-devices/index
>  +
>  +**Fixme**: some organizational work is still needed here.
>
>   .. toctree::
>      :maxdepth: 1
>
>      accounting/index
>      cpu-freq/index
>  -   fpga/index
>  -   i2c/index
>  -   iio/index
>      leds/index
>      pcmcia/index
>  -   spi/index
>  -   w1/index
>      watchdog/index
>      virt/index
>      hwmon/index
>  @@ -83,6 +91,5 @@ Storage interfaces
>      bpf/index
>      usb/index
>      PCI/index
>  -   misc-devices/index
>      peci/index
>      wmi/index
>  -- 
>  2.41.0

Re: [PATCH] docs: consolidate embedded interfaces

[Costa Shulyupin]

> I thought I was clear...I still don't see how this organization makes
> sense.
The last time you wrote was about the section "peripheral interfaces".
This is the first time I've submitted "embedded interfaces". You
haven't yet reviewed it.

>What is "embedded" about misc devices?
I've reviewed https://docs.kernel.org/misc-devices/ and found
that the most of described drivers are drivers for embedded devices:
- Digital Potentiometers
- combined ambient light and proximity sensor
- I2C EEPROM
- C2 Interface used for in-system programming of micro controllers
- accelerometer
- EEPROM-programmable power-supply
- 950 serial port devices
- Power Management IC
- Xilinx Soft-Decision Forward Error Correction block

Thanks,
Costa

>
> Thanks,
>
> jon
>
> > On Tue, 25 Jul 2023 at 16:56, Costa Shulyupin <costa.shul@redhat.com> wrote:
> >
> >  to make page Subsystems APIs 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 90a0535a932a..7453586114d4 100644
> >  --- a/Documentation/subsystem-apis.rst
> >  +++ b/Documentation/subsystem-apis.rst
> >  @@ -60,20 +60,28 @@ Storage interfaces
> >      scsi/index
> >      target/index
> >
> >  -**Fixme**: much more organizational work is needed here.
> >  +Embedded interfaces
> >  +-------------------
> >  +
> >  +.. toctree::
> >  +   :maxdepth: 1
> >  +
> >  +   iio/index
> >  +   spi/index
> >  +   i2c/index
> >  +   fpga/index
> >  +   w1/index
> >  +   misc-devices/index
> >  +
> >  +**Fixme**: some organizational work is still needed here.
> >
> >   .. toctree::
> >      :maxdepth: 1
> >
> >      accounting/index
> >      cpu-freq/index
> >  -   fpga/index
> >  -   i2c/index
> >  -   iio/index
> >      leds/index
> >      pcmcia/index
> >  -   spi/index
> >  -   w1/index
> >      watchdog/index
> >      virt/index
> >      hwmon/index
> >  @@ -83,6 +91,5 @@ Storage interfaces
> >      bpf/index
> >      usb/index
> >      PCI/index
> >  -   misc-devices/index
> >      peci/index
> >      wmi/index
> >  --
> >  2.41.0
>