mbox series

[00/11] Documentation/scsi: organize SCSI docs & make more readable

Message ID 20230518212749.18266-1-rdunlap@infradead.org (mailing list archive)
Headers show
Series Documentation/scsi: organize SCSI docs & make more readable | expand

Message

Randy Dunlap May 18, 2023, 9:27 p.m. UTC 
Organize the SCSI documentation into categories instead of
alphabetically by filename.

Modify several of the document chapter headings so that they are
shorter and easier to find.

Make several updates to the scsi-generic driver documentation.

 [PATCH 01/11] Docs/scsi: organize the SCSI documentation
 [PATCH 02/11] Docs/scsi: introduction: multiple cleanups
 [PATCH 03/11] Docs/scsi: arcmsr: use a chapter heading for clarity
 [PATCH 04/11] Docs/scsi: scsi-changer: shorten the chapter heading
 [PATCH 05/11] Docs/scsi: dc395x: shorten the chapter heading
 [PATCH 06/11] Docs/scsi: scsi_fc_transport: fix typo in heading
 [PATCH 07/11] Docs/scsi: scsi-generic: multiple cleanups
 [PATCH 08/11] Docs/scsi: g_NCR5380: shorten chapter heading
 [PATCH 09/11] Docs/scsi: megaraid: clarify chapter heading
 [PATCH 10/11] Docs/scsi: ncr53c8xx: shorten chapter heading
 [PATCH 11/11] Docs/scsi: sym53c8xx_2: shorten chapter heading


 Documentation/scsi/arcmsr_spec.rst       |    1 
 Documentation/scsi/dc395x.rst            |    6 +-
 Documentation/scsi/g_NCR5380.rst         |    6 +-
 Documentation/scsi/index.rst             |   37 ++++++++++++--
 Documentation/scsi/megaraid.rst          |    6 +-
 Documentation/scsi/ncr53c8xx.rst         |    6 +-
 Documentation/scsi/scsi-changer.rst      |    6 +-
 Documentation/scsi/scsi-generic.rst      |   53 ++++++++-------------
 Documentation/scsi/scsi.rst              |   23 +++------
 Documentation/scsi/scsi_fc_transport.rst |    8 +--
 Documentation/scsi/sym53c8xx_2.rst       |    6 +-
 11 files changed, 86 insertions(+), 72 deletions(-)


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
Cc: Gerd Knorr <kraxel@bytesex.org>
Cc: Oliver Neukum <oliver@neukum.org>
Cc: Ali Akcaagac <aliakc@web.de>
Cc: Jamie Lenehan <lenehan@twibble.org>
Cc: dc395x@twibble.org
Cc: James Smart <james.smart@broadcom.com>
Cc: Doug Gilbert <dgilbert@interlog.com>
Cc: Finn Thain <fthain@linux-m68k.org>
Cc: Michael Schmitz <schmitzmic@gmail.com>
Cc: Kashyap Desai <kashyap.desai@broadcom.com>
Cc: Sumit Saxena <sumit.saxena@broadcom.com>
Cc: Shivasharan S <shivasharan.srikanteshwara@broadcom.com>
Cc: megaraidlinux.pdl@broadcom.com
Cc: Matthew Wilcox <willy@infradead.org>

Comments

Martin K. Petersen May 22, 2023, 10:38 p.m. UTC | #1 
Randy,

> Organize the SCSI documentation into categories instead of
> alphabetically by filename.
>
> Modify several of the document chapter headings so that they are
> shorter and easier to find.
>
> Make several updates to the scsi-generic driver documentation.

Applied to 6.5/scsi-staging, thanks!
Martin K. Petersen June 1, 2023, 12:43 a.m. UTC | #2 
On Thu, 18 May 2023 14:27:38 -0700, Randy Dunlap wrote:

> Organize the SCSI documentation into categories instead of
> alphabetically by filename.
> 
> Modify several of the document chapter headings so that they are
> shorter and easier to find.
> 
> Make several updates to the scsi-generic driver documentation.
> 
> [...]

Applied to 6.5/scsi-queue, thanks!

[01/11] Docs/scsi: organize the SCSI documentation
        https://git.kernel.org/mkp/scsi/c/682b07d2ff54
[02/11] Docs/scsi: introduction: multiple cleanups
        https://git.kernel.org/mkp/scsi/c/c4e672ac8c49
[03/11] Docs/scsi: arcmsr: use a chapter heading for clarity
        https://git.kernel.org/mkp/scsi/c/1d3e21238f50
[04/11] Docs/scsi: scsi-changer: shorten the chapter heading
        https://git.kernel.org/mkp/scsi/c/a292835f69c6
[05/11] Docs/scsi: dc395x: shorten the chapter heading
        https://git.kernel.org/mkp/scsi/c/573a43f26d80
[06/11] Docs/scsi: scsi_fc_transport: fix typo in heading
        https://git.kernel.org/mkp/scsi/c/66fcd6026c71
[07/11] Docs/scsi: scsi-generic: multiple cleanups
        https://git.kernel.org/mkp/scsi/c/8ebddfeef518
[08/11] Docs/scsi: g_NCR5380: shorten chapter heading
        https://git.kernel.org/mkp/scsi/c/b636a0297e4f
[09/11] Docs/scsi: megaraid: clarify chapter heading
        https://git.kernel.org/mkp/scsi/c/0176d3395a3a
[10/11] Docs/scsi: ncr53c8xx: shorten chapter heading
        https://git.kernel.org/mkp/scsi/c/7c891fe3db3a
[11/11] Docs/scsi: sym53c8xx_2: shorten chapter heading
        https://git.kernel.org/mkp/scsi/c/f047d1e38bdf