diff mbox series

[02/11] Docs/scsi: introduction: multiple cleanups

Message ID 20230518212749.18266-3-rdunlap@infradead.org
State New
Headers show
Series Documentation/scsi: organize SCSI docs & make more readable | expand

Commit Message

Randy Dunlap May 18, 2023, 9:27 p.m. UTC 
Modify URLs to use https instead of http.
Remove ancient URLs that don't work.
Change "scsi" in text to "SCSI".
Change "cdrom" in text to "CD-ROM".
Drop the reference to "autoclean" for modules since I can't
  find it in any current documentation.

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/scsi.rst |   23 ++++++++++-------------
 1 file changed, 10 insertions(+), 13 deletions(-)

Comments

Finn Thain May 19, 2023, 4:53 a.m. UTC | #1 
On Thu, 18 May 2023, Randy Dunlap wrote:

> Modify URLs to use https instead of http.
> Remove ancient URLs that don't work.
> Change "scsi" in text to "SCSI".
> Change "cdrom" in text to "CD-ROM".
> Drop the reference to "autoclean" for modules since I can't
>   find it in any current documentation.
> 
> 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/scsi.rst |   23 ++++++++++-------------
>  1 file changed, 10 insertions(+), 13 deletions(-)
> 
> diff -- a/Documentation/scsi/scsi.rst b/Documentation/scsi/scsi.rst
> --- a/Documentation/scsi/scsi.rst
> +++ b/Documentation/scsi/scsi.rst
> @@ -6,30 +6,28 @@ SCSI subsystem documentation
>  
>  The Linux Documentation Project (LDP) maintains a document describing
>  the SCSI subsystem in the Linux kernel (lk) 2.4 series. See:
> -http://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single
> +https://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single
>  and multiple page HTML renderings as well as postscript and pdf.
> -It can also be found at:
> -http://web.archive.org/web/%2E/http://www.torque.net/scsi/SCSI-2.4-HOWTO
>  

That link got corrupted by commit b7223d9bdec. It used to be
http://web.archive.org/web/*/http://www.torque.net/scsi/SCSI-2.4-HOWTO
which does actually work.

FWIW, I'm not in favour of replacing any links with archive.org links 
unless no better source can be found. I am in favour of citations in the 
form of a link with retrieval date. In this context the date can often be 
inferred from commit or release dates.

Therefore, a second commit, 0ea6e611221, could also be reverted with 
regards to this link (if you're planning to edit it). Just my $0.02.
diff mbox series

Patch

diff -- a/Documentation/scsi/scsi.rst b/Documentation/scsi/scsi.rst
--- a/Documentation/scsi/scsi.rst
+++ b/Documentation/scsi/scsi.rst
@@ -6,30 +6,28 @@  SCSI subsystem documentation
 
 The Linux Documentation Project (LDP) maintains a document describing
 the SCSI subsystem in the Linux kernel (lk) 2.4 series. See:
-http://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single
+https://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single
 and multiple page HTML renderings as well as postscript and pdf.
-It can also be found at:
-http://web.archive.org/web/%2E/http://www.torque.net/scsi/SCSI-2.4-HOWTO
 
 Notes on using modules in the SCSI subsystem
 ============================================
-The scsi support in the linux kernel can be modularized in a number of
+The SCSI support in the Linux kernel can be modularized in a number of
 different ways depending upon the needs of the end user.  To understand
 your options, we should first define a few terms.
 
-The scsi-core (also known as the "mid level") contains the core of scsi
-support.  Without it you can do nothing with any of the other scsi drivers.
-The scsi core support can be a module (scsi_mod.o), or it can be built into
-the kernel. If the core is a module, it must be the first scsi module
+The scsi-core (also known as the "mid level") contains the core of SCSI
+support.  Without it you can do nothing with any of the other SCSI drivers.
+The SCSI core support can be a module (scsi_mod.o), or it can be built into
+the kernel. If the core is a module, it must be the first SCSI module
 loaded, and if you unload the modules, it will have to be the last one
-unloaded.  In practice the modprobe and rmmod commands (and "autoclean")
+unloaded.  In practice the modprobe and rmmod commands
 will enforce the correct ordering of loading and unloading modules in
 the SCSI subsystem.
 
 The individual upper and lower level drivers can be loaded in any order
-once the scsi core is present in the kernel (either compiled in or loaded
-as a module).  The disk driver (sd_mod.o), cdrom driver (sr_mod.o),
-tape driver [1]_ (st.o) and scsi generics driver (sg.o) represent the upper
+once the SCSI core is present in the kernel (either compiled in or loaded
+as a module).  The disk driver (sd_mod.o), CD-ROM driver (sr_mod.o),
+tape driver [1]_ (st.o) and SCSI generics driver (sg.o) represent the upper
 level drivers to support the various assorted devices which can be
 controlled.  You can for example load the tape driver to use the tape drive,
 and then unload it once you have no further need for the driver (and release
@@ -44,4 +42,3 @@  built into the kernel.
 
 .. [1] There is a variant of the st driver for controlling OnStream tape
        devices. Its module name is osst.o .
-