linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] docs: consolidate storage interfaces
@ 2023-05-29  8:55 Costa Shulyupin
  2023-05-30  8:54 ` Bagas Sanjaya
  0 siblings, 1 reply; 14+ messages in thread
From: Costa Shulyupin @ 2023-05-29  8:55 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Costa Shulyupin, open list

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 55c90d5383ef..f7fe772835e5 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -22,6 +22,17 @@ Human interfaces
    gpu/index
    fb/index
 
+Storage interfaces
+------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   filesystems/index
+   block/index
+   cdrom/index
+   scsi/index
+
 **Fixme**: much more organizational work is needed here.
 
 .. toctree::
@@ -31,8 +42,6 @@ Human interfaces
    core-api/index
    locking/index
    accounting/index
-   block/index
-   cdrom/index
    cpu-freq/index
    fpga/index
    i2c/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
-- 
2.40.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH] docs: consolidate storage interfaces
  2023-05-29  8:55 [PATCH] docs: consolidate storage interfaces Costa Shulyupin
@ 2023-05-30  8:54 ` Bagas Sanjaya
  2023-05-31 10:17   ` [PATCH] docs: organize subsystems Costa Shulyupin
  0 siblings, 1 reply; 14+ messages in thread
From: Bagas Sanjaya @ 2023-05-30  8:54 UTC (permalink / raw)
  To: Costa Shulyupin, Jonathan Corbet, linux-doc; +Cc: open list

On 5/29/23 15:55, Costa Shulyupin wrote:
> +Storage interfaces
> +------------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   filesystems/index
> +   block/index
> +   cdrom/index
> +   scsi/index
> +
>  **Fixme**: much more organizational work is needed here.
>  

Can you also categorize below indexes (table of contents) like above?

>  .. toctree::
> @@ -31,8 +42,6 @@ Human interfaces
>     core-api/index
>     locking/index
>     accounting/index
> -   block/index
> -   cdrom/index
>     cpu-freq/index
>     fpga/index
>     i2c/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

Thanks.

-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply	[flat|nested] 14+ messages in thread

* [PATCH] docs: organize subsystems
  2023-05-30  8:54 ` Bagas Sanjaya
@ 2023-05-31 10:17   ` Costa Shulyupin
  2023-06-01  3:13     ` Bagas Sanjaya
  0 siblings, 1 reply; 14+ messages in thread
From: Costa Shulyupin @ 2023-05-31 10:17 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc, Bagas Sanjaya; +Cc: Costa Shulyupin, open list

[-- 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


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH] docs: organize subsystems
  2023-05-31 10:17   ` [PATCH] docs: organize subsystems Costa Shulyupin
@ 2023-06-01  3:13     ` Bagas Sanjaya
  2023-06-01 14:55       ` [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems Costa Shulyupin
  0 siblings, 1 reply; 14+ messages in thread
From: Bagas Sanjaya @ 2023-06-01  3:13 UTC (permalink / raw)
  To: Costa Shulyupin, Jonathan Corbet, linux-doc; +Cc: open list

On Wed, May 31, 2023 at 01:17:15PM +0300, Costa Shulyupin wrote:
> as requested.
> 
> Add classes:
> * Core subsystems
> * Storage interfaces
> * Networking interfaces
> * Peripherals interfaces
> * Embedded interfaces
> * Other subsystems

This is v2, right? If so, please properly version your patch(es).

> 
> 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

There is more to be sorted, though (and mind patch description, because I
rewrite it):

---- >8 ----
From 81bcb6042497a829ec4e3880cb75fc5c7e7e4e2b Mon Sep 17 00:00:00 2001
From: Costa Shulyupin <costa.shul@redhat.com>
Date: Wed, 31 May 2023 13:17:15 +0300
Subject: [PATCH] Documentation: subsystem-apis: Categorize remaining
 subsystems

There is a FIXME that says to organize subsystems listed in
subsystem-apis.rst. Fulfill it by categorize remaining subsytems
by purpose/themes, while sorting entries in each category.

HID devices are already categorized in 3c591cc954d56e ("docs:
consolidate human interface subsystems").

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
Link: https://lore.kernel.org/r/20230531101715.3256681-1-costa.shul@redhat.com
[Bagas: rewrite patch description to be clearer and categorize a few more subsystems]
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/subsystem-apis.rst | 123 ++++++++++++++++++++++---------
 1 file changed, 88 insertions(+), 35 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef88..2c0b18a66e4e00 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,58 +10,111 @@ 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
+   cpu-freq/index
+   driver-api/index
+   locking/index
+   mm/index
+   power/index
+   scheduler/index
+   timers/index
+   wmi/index
+
 Human interfaces
 ----------------
 
 .. toctree::
    :maxdepth: 1
 
-   input/index
-   hid/index
-   sound/index
-   gpu/index
    fb/index
+   gpu/index
+   hid/index
+   input/index
+   sound/index
 
-**Fixme**: much more organizational work is needed here.
+Storage
+-------
 
 .. toctree::
    :maxdepth: 1
 
-   driver-api/index
-   core-api/index
-   locking/index
-   accounting/index
    block/index
    cdrom/index
-   cpu-freq/index
+   filesystems/index
+   pcmcia/index
+   scsi/index
+   target/index
+
+
+Networking
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   bpf/index
+   infiniband/index
+   isdn/index
+   mhi/index
+   netlabel/index
+   networking/index
+
+
+Peripherals and devices
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   PCI/index
+   hwmon/index
+   leds/index
+   misc-devices/index
+   usb/index
+
+
+Embedded systems
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
    fpga/index
    i2c/index
    iio/index
-   isdn/index
-   infiniband/index
-   leds/index
-   netlabel/index
-   networking/index
-   pcmcia/index
-   power/index
-   target/index
-   timers/index
+   peci/index
    spi/index
    w1/index
-   watchdog/index
-   virt/index
-   hwmon/index
-   accel/index
-   security/index
+
+Integrity
+---------
+
+.. toctree::
+   :maxdepth: 1
+
    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
+   security/index
+
+Virtualization
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
+   virt/index
+
+Miscellaneous
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+   accel/index
+   accounting/index
+   watchdog/index
-- 
An old man doll... just what I always wanted! - Clara

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  2023-06-01  3:13     ` Bagas Sanjaya
@ 2023-06-01 14:55       ` Costa Shulyupin
  2023-06-01 16:28         ` Randy Dunlap
                           ` (2 more replies)
  0 siblings, 3 replies; 14+ messages in thread
From: Costa Shulyupin @ 2023-06-01 14:55 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc, Bagas Sanjaya
  Cc: Costa Shulyupin, open list, open list:BPF [MISC]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 3150 bytes --]

From: Bagas Sanjaya <bagasdotme@gmail.com>

Add classes:
* Core subsystems
* Storage
* Networking
* Peripherals and devices
* Embedded systems
* Integrity
* Virtualization
* Miscellaneous

There is a FIXME that says to organize subsystems listed in
subsystem-apis.rst. Fulfill it by categorize remaining subsytems
by purpose/themes, while sorting entries in each category.

HID devices are already categorized in 3c591cc954d56e ("docs:
consolidate human interface subsystems").

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

---

Changes:
v3: add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
v2: add Core subsystems, Networking, Peripherals and Embedded
v1: add Storgre category
---
 Documentation/subsystem-apis.rst | 119 ++++++++++++++++++++++---------
 1 file changed, 86 insertions(+), 33 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 55c90d5383ef..2c0b18a66e4e 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,58 +10,111 @@ 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
+   cpu-freq/index
+   driver-api/index
+   locking/index
+   mm/index
+   power/index
+   scheduler/index
+   timers/index
+   wmi/index
+
 Human interfaces
 ----------------
 
 .. toctree::
    :maxdepth: 1
 
-   input/index
+   fb/index
+   gpu/index
    hid/index
+   input/index
    sound/index
-   gpu/index
-   fb/index
 
-**Fixme**: much more organizational work is needed here.
+Storage
+-------
 
 .. toctree::
    :maxdepth: 1
 
-   driver-api/index
-   core-api/index
-   locking/index
-   accounting/index
    block/index
    cdrom/index
-   cpu-freq/index
-   fpga/index
-   i2c/index
-   iio/index
-   isdn/index
+   filesystems/index
+   pcmcia/index
+   scsi/index
+   target/index
+
+
+Networking
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   bpf/index
    infiniband/index
-   leds/index
+   isdn/index
+   mhi/index
    netlabel/index
    networking/index
-   pcmcia/index
-   power/index
-   target/index
-   timers/index
+
+
+Peripherals and devices
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   PCI/index
+   hwmon/index
+   leds/index
+   misc-devices/index
+   usb/index
+
+
+Embedded systems
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   fpga/index
+   i2c/index
+   iio/index
+   peci/index
    spi/index
    w1/index
-   watchdog/index
+
+Integrity
+---------
+
+.. toctree::
+   :maxdepth: 1
+
+   crypto/index
+   security/index
+
+Virtualization
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
    virt/index
-   hwmon/index
+
+Miscellaneous
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
    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
+   accounting/index
+   watchdog/index
-- 
2.40.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  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-09  8:05         ` Jonathan Corbet
  2 siblings, 0 replies; 14+ messages in thread
From: Randy Dunlap @ 2023-06-01 16:28 UTC (permalink / raw)
  To: Costa Shulyupin, Jonathan Corbet, linux-doc, Bagas Sanjaya
  Cc: open list, open list:BPF [MISC]

Hi--

On 6/1/23 07:55, Costa Shulyupin wrote:
> From: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Add classes:
> * Core subsystems
> * Storage
> * Networking
> * Peripherals and devices
> * Embedded systems
> * Integrity
> * Virtualization
> * Miscellaneous
> 
> There is a FIXME that says to organize subsystems listed in
> subsystem-apis.rst. Fulfill it by categorize remaining subsytems
> by purpose/themes, while sorting entries in each category.
> 
> HID devices are already categorized in 3c591cc954d56e ("docs:
> consolidate human interface subsystems").
> 
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>

This is a worthy goal, I am sure, but I am also sure that there is
a lot of bikeshedding that can go on here.
(examples below)

> 
> ---
> 
> Changes:
> v3: add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya
> v2: add Core subsystems, Networking, Peripherals and Embedded
> v1: add Storgre category

          Storage

> ---
>  Documentation/subsystem-apis.rst | 119 ++++++++++++++++++++++---------
>  1 file changed, 86 insertions(+), 33 deletions(-)
> 
> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index 55c90d5383ef..2c0b18a66e4e 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -10,58 +10,111 @@ 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
> +   cpu-freq/index
> +   driver-api/index
> +   locking/index
> +   mm/index
> +   power/index
> +   scheduler/index
> +   timers/index
> +   wmi/index
> +
>  Human interfaces
>  ----------------
>  
>  .. toctree::
>     :maxdepth: 1
>  
> -   input/index
> +   fb/index
> +   gpu/index
>     hid/index
> +   input/index
>     sound/index
> -   gpu/index
> -   fb/index
>  
> -**Fixme**: much more organizational work is needed here.
> +Storage
> +-------
>  
>  .. toctree::
>     :maxdepth: 1
>  
> -   driver-api/index
> -   core-api/index
> -   locking/index
> -   accounting/index
>     block/index
>     cdrom/index
> -   cpu-freq/index
> -   fpga/index
> -   i2c/index
> -   iio/index
> -   isdn/index
> +   filesystems/index
> +   pcmcia/index

Why is pcmcia in the storage category?
It's just an interface (or a bus).

> +   scsi/index

SCSI is also just a bus, but most (all?) of our drivers
are for storage controllers AFAIK, although I have seen
SCSI printer drivers, maybe even a SCSI toaster driver. :)

> +   target/index
> +
> +
> +Networking
> +----------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   bpf/index
>     infiniband/index
> -   leds/index
> +   isdn/index
> +   mhi/index
>     netlabel/index
>     networking/index
> -   pcmcia/index
> -   power/index
> -   target/index
> -   timers/index
> +
> +
> +Peripherals and devices
> +-----------------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   PCI/index
> +   hwmon/index
> +   leds/index
> +   misc-devices/index
> +   usb/index
> +
> +
> +Embedded systems
> +----------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   fpga/index
> +   i2c/index

I2C is just a bus IMO.
Same with SPI and W1.
Should we have a "Bus Interfaces" category?

> +   iio/index
> +   peci/index
>     spi/index
>     w1/index
> -   watchdog/index
> +
> +Integrity
> +---------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   crypto/index
> +   security/index
> +
> +Virtualization
> +--------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
>     virt/index
> -   hwmon/index
> +
> +Miscellaneous
> +-------------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
>     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
> +   accounting/index
> +   watchdog/index

Thanks.
-- 
~Randy

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  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-09  8:05         ` Jonathan Corbet
  2 siblings, 1 reply; 14+ messages in thread
From: Bagas Sanjaya @ 2023-06-02 10:08 UTC (permalink / raw)
  To: Costa Shulyupin, Jonathan Corbet, linux-doc
  Cc: Linux Kernel Mailing List, Linux BPF

[-- Attachment #1: Type: text/plain, Size: 1633 bytes --]

On Thu, Jun 01, 2023 at 05:55:55PM +0300, Costa Shulyupin wrote:
> From: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Add classes:
> * Core subsystems
> * Storage
> * Networking
> * Peripherals and devices
> * Embedded systems
> * Integrity
> * Virtualization
> * Miscellaneous

Above list is unnecessary, because the diff should clearly show those
categories.

> 
> There is a FIXME that says to organize subsystems listed in
> subsystem-apis.rst. Fulfill it by categorize remaining subsytems
> by purpose/themes, while sorting entries in each category.
> 
> HID devices are already categorized in 3c591cc954d56e ("docs:
> consolidate human interface subsystems").
> 
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>

Thanks for picking my version from v2 [1]. However, From: address in the
patch message doesn't match one from message header nor your Signed-off-by
address. Conversely, if you handle someone else's patch (in this case mine),
you need to also add SoB from him/her.

As you're still newbie here, I'd recommend you to try contributing to
drivers/staging/ first in order to gain experience on kernel developement
workflow. Also, you use your RedHat address, so I expect you have been
given kernel development training from your company (and doesn't make
trivial errors like these ones).

Anyway, I'd like to send my own version instead (incorporating feedback
from this version) if you still reroll with trivial sending mistakes.

Thanks.

[1]: https://lore.kernel.org/linux-doc/ZHgM0qKWP3OusjUW@debian.me/
 
-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  2023-06-02 10:08         ` Bagas Sanjaya
@ 2023-06-02 10:19           ` Jonathan Corbet
  2023-06-02 12:33             ` Bagas Sanjaya
  0 siblings, 1 reply; 14+ messages in thread
From: Jonathan Corbet @ 2023-06-02 10:19 UTC (permalink / raw)
  To: Bagas Sanjaya, Costa Shulyupin, linux-doc
  Cc: Linux Kernel Mailing List, Linux BPF

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> As you're still newbie here, I'd recommend you to try contributing to
> drivers/staging/ first in order to gain experience on kernel developement
> workflow. Also, you use your RedHat address, so I expect you have been
> given kernel development training from your company (and doesn't make
> trivial errors like these ones).

Bagas, please.  I'll ask you directly: please don't go telling
documentation contributors how to comport themselves; you have plenty
enough to learn yourself on that front.  It's hard enough to get
contributors to the documentation as it is without random people showing
up and giving orders.

I have distractions that are increasing my (already less than stellar)
latency, but I'll get to this stuff.

Thanks,

jon

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  2023-06-02 10:19           ` Jonathan Corbet
@ 2023-06-02 12:33             ` Bagas Sanjaya
  0 siblings, 0 replies; 14+ messages in thread
From: Bagas Sanjaya @ 2023-06-02 12:33 UTC (permalink / raw)
  To: Jonathan Corbet, Costa Shulyupin, linux-doc
  Cc: Linux Kernel Mailing List, Linux BPF

On 6/2/23 17:19, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> As you're still newbie here, I'd recommend you to try contributing to
>> drivers/staging/ first in order to gain experience on kernel developement
>> workflow. Also, you use your RedHat address, so I expect you have been
>> given kernel development training from your company (and doesn't make
>> trivial errors like these ones).
> 
> Bagas, please.  I'll ask you directly: please don't go telling
> documentation contributors how to comport themselves; you have plenty
> enough to learn yourself on that front.  It's hard enough to get
> contributors to the documentation as it is without random people showing
> up and giving orders.
> 

Hi jon, thanks for another tip. I also learn contributing patches the
hard way by being rejected (honestly sometimes I learn, sometimes I
don't).

Let me clarify the situation. Previously in v2, I reviewed Costa's patch
by replying with proposing my own version, keeping patch author intact.
There, I categorized a few more items while sorting all of them. I
treated it as minor fixup that was attributed by brackets in the
SoB area (I could also use Co-developed-by: for this purpose too).
Then, Costa rerolled v3 using my version, but the From: address
in the patch message is mine without corresponding SoB, hence when you
apply his v3, there would be author mismatch (commit author is me
yet different SoB from him). I expected that my proposal in v2 is
carried by him (and also have SoB from both me and him as the sender
who carried my patch).

> I have distractions that are increasing my (already less than stellar)
> latency, but I'll get to this stuff.
> 

I'm too, because I'm AuDHD and I can (and do) easily distracted; living
in a paradox between routine fixation and desire for quick action :).

Thanks.

-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems
  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-09  8:05         ` Jonathan Corbet
  2023-06-18  6:29           ` [PATCH v4] docs: consolidate storage interfaces Costa Shulyupin
  2 siblings, 1 reply; 14+ messages in thread
From: Jonathan Corbet @ 2023-06-09  8:05 UTC (permalink / raw)
  To: Costa Shulyupin, linux-doc, Bagas Sanjaya
  Cc: Costa Shulyupin, open list, open list:BPF [MISC]

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

> From: Bagas Sanjaya <bagasdotme@gmail.com>
>
> Add classes:
> * Core subsystems
> * Storage
> * Networking
> * Peripherals and devices
> * Embedded systems
> * Integrity
> * Virtualization
> * Miscellaneous
>
> There is a FIXME that says to organize subsystems listed in
> subsystem-apis.rst. Fulfill it by categorize remaining subsytems
> by purpose/themes, while sorting entries in each category.
>
> HID devices are already categorized in 3c591cc954d56e ("docs:
> consolidate human interface subsystems").
>
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>

So now that I've found a moment to look at stuff, I'm a bit confused
here.  Up top, you have a From: line identifying Bagas as the author of
this patch - but it lacks his signoff so I can't apply it.

If this is *really* such a complex change that it needs a
co-developed-by tag, please arrange that and the correct signoffs.
Otherwise, please send a patch that's your work (which can certainly
reflect suggestions from others) that is properly tagged.

Thanks,

jon

^ permalink raw reply	[flat|nested] 14+ messages in thread

* [PATCH v4] docs: consolidate storage interfaces
  2023-06-09  8:05         ` Jonathan Corbet
@ 2023-06-18  6:29           ` Costa Shulyupin
  2023-06-18 15:19             ` Randy Dunlap
  2023-06-21 15:33             ` Jonathan Corbet
  0 siblings, 2 replies; 14+ messages in thread
From: Costa Shulyupin @ 2023-06-18  6:29 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Costa Shulyupin, open list

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(-)

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
-- 
2.40.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH v4] docs: consolidate storage interfaces
  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
  1 sibling, 1 reply; 14+ messages in thread
From: Randy Dunlap @ 2023-06-18 15:19 UTC (permalink / raw)
  To: Costa Shulyupin, Jonathan Corbet, linux-doc; +Cc: open list

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

-- 
~Randy

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v4] docs: consolidate storage interfaces
  2023-06-18 15:19             ` Randy Dunlap
@ 2023-06-18 16:09               ` Costa Shulyupin
  0 siblings, 0 replies; 14+ messages in thread
From: Costa Shulyupin @ 2023-06-18 16:09 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: Jonathan Corbet, linux-doc, open list

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.


^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH v4] docs: consolidate storage interfaces
  2023-06-18  6:29           ` [PATCH v4] docs: consolidate storage interfaces Costa Shulyupin
  2023-06-18 15:19             ` Randy Dunlap
@ 2023-06-21 15:33             ` Jonathan Corbet
  1 sibling, 0 replies; 14+ messages in thread
From: Jonathan Corbet @ 2023-06-21 15:33 UTC (permalink / raw)
  To: Costa Shulyupin, linux-doc; +Cc: Costa Shulyupin, open list

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

^ permalink raw reply	[flat|nested] 14+ messages in thread

end of thread, other threads:[~2023-06-21 15:33 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-29  8:55 [PATCH] docs: consolidate storage interfaces Costa Shulyupin
2023-05-30  8:54 ` Bagas Sanjaya
2023-05-31 10:17   ` [PATCH] docs: organize subsystems Costa Shulyupin
2023-06-01  3:13     ` 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

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).