[v4] docs: consolidate storage interfaces

Message ID 20230618062937.481280-1-costa.shul@redhat.com
State New
Headers
Series [v4] docs: consolidate storage interfaces |

Commit Message

Costa Shulyupin June 18, 2023, 6:29 a.m. UTC
  to make the page more organized as requested

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>

---

Changes:
 v4. rollback to single Storage category, add 'TCM Virtual Device'
 v3. add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
 v2. add Core subsystems, Networking, Peripherals and Embedded
 v1. add Storage category
---
 Documentation/subsystem-apis.rst | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)
  

Comments

Randy Dunlap June 18, 2023, 3:19 p.m. UTC | #1
Hi Costa,

On 6/17/23 23:29, Costa Shulyupin wrote:
> to make the page more organized as requested
> 
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> 
> ---
> 
> Changes:
>  v4. rollback to single Storage category, add 'TCM Virtual Device'

What does the TCM Virtual Device comment refer to?

Otherwise LGTM.
Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

>  v3. add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
>  v2. add Core subsystems, Networking, Peripherals and Embedded
>  v1. add Storage category
> ---
>  Documentation/subsystem-apis.rst | 17 ++++++++++++-----
>  1 file changed, 12 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index 55c90d5383ef..b67a1b65855b 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -22,6 +22,18 @@ Human interfaces
>     gpu/index
>     fb/index
>  
> +Storage interfaces
> +------------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   filesystems/index
> +   block/index
> +   cdrom/index
> +   scsi/index
> +   target/index
> +
>  **Fixme**: much more organizational work is needed here.
>  
>  .. toctree::
> @@ -31,8 +43,6 @@ Human interfaces
>     core-api/index
>     locking/index
>     accounting/index
> -   block/index
> -   cdrom/index
>     cpu-freq/index
>     fpga/index
>     i2c/index
> @@ -44,7 +54,6 @@ Human interfaces
>     networking/index
>     pcmcia/index
>     power/index
> -   target/index
>     timers/index
>     spi/index
>     w1/index
> @@ -54,12 +63,10 @@ Human interfaces
>     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
  
Costa Shulyupin June 18, 2023, 4:09 p.m. UTC | #2
On Sun, 18 Jun 2023 at 18:20, Randy Dunlap <rdunlap@infradead.org> wrote:
> What does the TCM Virtual Device comment refer to?

TCM stands for Target Core Mod.
It is configured by CONFIG_TARGET_CORE.
The moved doc is https://docs.kernel.org/target/. Good example to not
name directories.
It says "TCM is another name for LIO, an in-kernel iSCSI target (server)."
LIO stands for Linux-IO: https://en.wikipedia.org/wiki/LIO_(SCSI_target)

Thank you.
  
Jonathan Corbet June 21, 2023, 3:33 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>
>
> ---
>
> Changes:
>  v4. rollback to single Storage category, add 'TCM Virtual Device'
>  v3. add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
>  v2. add Core subsystems, Networking, Peripherals and Embedded
>  v1. add Storage category
> ---
>  Documentation/subsystem-apis.rst | 17 ++++++++++++-----
>  1 file changed, 12 insertions(+), 5 deletions(-)

Applied, thanks.

jon
  

Patch

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef..b67a1b65855b 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -22,6 +22,18 @@  Human interfaces
    gpu/index
    fb/index
 
+Storage interfaces
+------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   filesystems/index
+   block/index
+   cdrom/index
+   scsi/index
+   target/index
+
 **Fixme**: much more organizational work is needed here.
 
 .. toctree::
@@ -31,8 +43,6 @@  Human interfaces
    core-api/index
    locking/index
    accounting/index
-   block/index
-   cdrom/index
    cpu-freq/index
    fpga/index
    i2c/index
@@ -44,7 +54,6 @@  Human interfaces
    networking/index
    pcmcia/index
    power/index
-   target/index
    timers/index
    spi/index
    w1/index
@@ -54,12 +63,10 @@  Human interfaces
    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