Commit d4d79340 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Martin K. Petersen
Browse files

scsi: docs: convert scsi-generic.txt to ReST 

Link: https://lore.kernel.org/r/f57b8ddf30397c2c7213e49634e5e9cbd4246368.1583136624.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent fedd7a4d

Documentation/scsi/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -34,5 +34,6 @@ Linux SCSI Subsystem 
   scsi-changer

   scsi_eh

   scsi_fc_transport

   scsi-generic



   scsi_transport_srp/figures

Documentation/scsi/scsi-generic.txt→Documentation/scsi/scsi-generic.rst

+46 −29
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=======================================

Notes on Linux SCSI Generic (sg) driver

            ---------------------------------------

=======================================



                                                        20020126



Introduction

============

The SCSI Generic driver (sg) is one of the four "high level" SCSI device
@@ -30,11 +35,15 @@ Sg driver documentation 
=======================

The most recent documentation of the sg driver is kept at the Linux

Documentation Project's (LDP) site:

http://www.tldp.org/HOWTO/SCSI-Generic-HOWTO



- http://www.tldp.org/HOWTO/SCSI-Generic-HOWTO



This describes the sg version 3 driver found in the lk 2.4 series.



The LDP renders documents in single and multiple page HTML, postscript

and pdf. This document can also be found at:

http://sg.danny.cz/sg/p/sg_v3_ho.html



- http://sg.danny.cz/sg/p/sg_v3_ho.html



Documentation for the version 2 sg driver found in the lk 2.2 series can

be found at http://sg.danny.cz/sg/. A larger version
@@ -57,9 +66,13 @@ part can be found at http://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . 
Example code and utilities

==========================

There are two packages of sg utilities:

  - sg3_utils   for the sg version 3 driver found in lk 2.4

  - sg_utils    for the sg version 2 (and original) driver found in lk 2.2



    =========   ==========================================================

    sg3_utils   for the sg version 3 driver found in lk 2.4

    sg_utils    for the sg version 2 (and original) driver found in lk 2.2

                and earlier

    =========   ==========================================================



Both packages will work in the lk 2.4 series however sg3_utils offers more

capabilities. They can be found at: http://sg.danny.cz/sg/sg3_utils.html and

freecode.com
@@ -72,24 +85,26 @@ Mapping of Linux kernel versions to sg driver versions 
======================================================

Here is a list of linux kernels in the 2.4 series that had new version

of the sg driver:

      lk 2.4.0 : sg version 3.1.17

      lk 2.4.7 : sg version 3.1.19 

      lk 2.4.10 : sg version 3.1.20  **

      lk 2.4.17 : sg version 3.1.22 



** There were 3 changes to sg version 3.1.20 by third parties in the

     - lk 2.4.0 : sg version 3.1.17

     - lk 2.4.7 : sg version 3.1.19

     - lk 2.4.10 : sg version 3.1.20 [#]_

     - lk 2.4.17 : sg version 3.1.22



.. [#] There were 3 changes to sg version 3.1.20 by third parties in the

       next six linux kernel versions.



For reference here is a list of linux kernels in the 2.2 series that had

new version of the sg driver:

      lk 2.2.0 : original sg version [with no version number]

      lk 2.2.6 : sg version 2.1.31

      lk 2.2.8 : sg version 2.1.32

      lk 2.2.10 : sg version 2.1.34 [SG_GET_VERSION_NUM ioctl first appeared]

      lk 2.2.14 : sg version 2.1.36

      lk 2.2.16 : sg version 2.1.38

      lk 2.2.17 : sg version 2.1.39

      lk 2.2.20 : sg version 2.1.40



     - lk 2.2.0 : original sg version [with no version number]

     - lk 2.2.6 : sg version 2.1.31

     - lk 2.2.8 : sg version 2.1.32

     - lk 2.2.10 : sg version 2.1.34 [SG_GET_VERSION_NUM ioctl first appeared]

     - lk 2.2.14 : sg version 2.1.36

     - lk 2.2.16 : sg version 2.1.38

     - lk 2.2.17 : sg version 2.1.39

     - lk 2.2.20 : sg version 2.1.40



The lk 2.5 development series has recently commenced and it currently

contains sg version 3.5.23 which is functionally equivalent to sg
@@ -97,5 +112,7 @@ version 3.1.22 found in lk 2.4.17 . 




Douglas Gilbert



26th January 2002



dgilbert@interlog.com

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -14797,7 +14797,7 @@ M: Doug Gilbert <dgilbert@interlog.com> 
L:	linux-scsi@vger.kernel.org

W:	http://sg.danny.cz/sg

S:	Maintained

F:	Documentation/scsi/scsi-generic.txt

F:	Documentation/scsi/scsi-generic.rst

F:	drivers/scsi/sg.c

F:	include/scsi/sg.h
































drivers/scsi/Kconfig



+1
−1






























Original line number
Diff line number
Diff line







@@ -133,7 +133,7 @@ config CHR_DEV_SG







	  quality digital reader of audio CDs (<http://www.xiph.org/paranoia/>).









	  For other devices, it's possible that you'll have to write the









	  driver software yourself. Please read the file









	  <file:Documentation/scsi/scsi-generic.txt> for more information.









	  <file:Documentation/scsi/scsi-generic.rst> for more information.



















	  To compile this driver as a module, choose M here and read









	  <file:Documentation/scsi/scsi.txt>. The module will be called sg.
































include/scsi/sg.h



+1
−1






























Original line number
Diff line number
Diff line







@@ -24,7 +24,7 @@







 *	http://sg.danny.cz/sg  [alternatively check the MAINTAINERS file]









 * The documentation for the sg version 3 driver can be found at:









 *	http://sg.danny.cz/sg/p/sg_v3_ho.html









 * Also see: <kernel_source>/Documentation/scsi/scsi-generic.txt









 * Also see: <kernel_source>/Documentation/scsi/scsi-generic.rst









 *









 * For utility and test programs see: http://sg.danny.cz/sg/sg3_utils.html









 */