mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	"James E.J. Bottomley" <jejb@linux.ibm.com>,
	"Martin K. Petersen" <martin.petersen@oracle.com>,
	linux-scsi@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 01/11] Docs/scsi: organize the SCSI documentation
Date: Thu, 18 May 2023 14:27:39 -0700	[thread overview]
Message-ID: <20230518212749.18266-2-rdunlap@infradead.org> (raw)
In-Reply-To: <20230518212749.18266-1-rdunlap@infradead.org>

Break the SCSI documentation up into categories:
  Introduction, APIs, driver parameters, and host adapter drivers
instead of alphabetical by document file name (i.e., no organization).

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/scsi/index.rst |   37 ++++++++++++++++++++++++++++-----
 1 file changed, 32 insertions(+), 5 deletions(-)

diff -- a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -7,6 +7,38 @@ SCSI Subsystem
 .. toctree::
    :maxdepth: 1
 
+Introduction
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   scsi
+
+SCSI driver APIs
+================
+
+.. toctree::
+   :maxdepth: 1
+
+   scsi_mid_low_api
+   scsi_eh
+
+SCSI driver parameters
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   scsi-parameters
+   link_power_management_policy
+
+SCSI host adapter drivers
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
    53c700
    aacraid
    advansys
@@ -25,7 +57,6 @@ SCSI Subsystem
    hpsa
    hptiop
    libsas
-   link_power_management_policy
    lpfc
    megaraid
    ncr53c8xx
@@ -33,12 +64,8 @@ SCSI Subsystem
    ppa
    qlogicfas
    scsi-changer
-   scsi_eh
    scsi_fc_transport
    scsi-generic
-   scsi_mid_low_api
-   scsi-parameters
-   scsi
    sd-parameters
    smartpqi
    st

  reply	other threads:[~2023-05-18 21:27 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-18 21:27 [PATCH 00/11] Documentation/scsi: organize SCSI docs & make more readable Randy Dunlap
2023-05-18 21:27 ` Randy Dunlap [this message]
2023-05-18 21:27 ` [PATCH 02/11] Docs/scsi: introduction: multiple cleanups Randy Dunlap
2023-05-19  4:53   ` Finn Thain
2023-05-18 21:27 ` [PATCH 03/11] Docs/scsi: arcmsr: use a chapter heading for clarity Randy Dunlap
2023-05-18 21:27 ` [PATCH 04/11] Docs/scsi: scsi-changer: shorten the chapter heading Randy Dunlap
2023-05-18 21:27 ` [PATCH 05/11] Docs/scsi: dc395x: " Randy Dunlap
2023-06-01  2:08   ` Bagas Sanjaya
2023-05-18 21:27 ` [PATCH 06/11] Docs/scsi: scsi_fc_transport: fix typo in heading Randy Dunlap
2023-05-18 21:27 ` [PATCH 07/11] Docs/scsi: scsi-generic: multiple cleanups Randy Dunlap
2023-05-18 21:27 ` [PATCH 08/11] Docs/scsi: g_NCR5380: shorten chapter heading Randy Dunlap
2023-05-19  4:45   ` Finn Thain
2023-05-18 21:27 ` [PATCH 09/11] Docs/scsi: megaraid: clarify " Randy Dunlap
2023-05-18 21:27 ` [PATCH 10/11] Docs/scsi: ncr53c8xx: shorten " Randy Dunlap
2023-05-18 21:27 ` [PATCH 11/11] Docs/scsi: sym53c8xx_2: " Randy Dunlap
2023-05-22 22:38 ` [PATCH 00/11] Documentation/scsi: organize SCSI docs & make more readable Martin K. Petersen
2023-06-01  0:43 ` Martin K. Petersen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230518212749.18266-2-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=jejb@linux.ibm.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®