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

Link: https://lore.kernel.org/r/433d073fa982174a19783c2e59412b724e2cf946.1583136624.git.mchehab+huawei@kernel.org
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 29e211e..635a3b3 100644 (file)
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -31,5 +31,6 @@ Linux SCSI Subsystem
    NinjaSCSI
    ppa
    qlogicfas
+   scsi-changer
 
    scsi_transport_srp/figures

diff --git a/Documentation/scsi/scsi-changer.txt b/Documentation/scsi/scsi-changer.rst
similarity index 87%
rename from Documentation/scsi/scsi-changer.txt
rename to Documentation/scsi/scsi-changer.rst
index ade046e..ab60e7e 100644 (file)
--- a/Documentation/scsi/scsi-changer.txt
+++ b/Documentation/scsi/scsi-changer.rst
@@ -1,4 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
 
+========================================
 README for the SCSI media changer driver
 ========================================
 
@@ -28,15 +30,17 @@ The SCSI changer model is complex, compared to - for example - IDE-CD
 changers. But it allows to handle nearly all possible cases. It knows
 4 different types of changer elements:
 
-  media transport - this one shuffles around the media, i.e. the
+  ===============   ==================================================
+  media transport   this one shuffles around the media, i.e. the
                     transport arm.  Also known as "picker".
-  storage         - a slot which can hold a media.
-  import/export   - the same as above, but is accessible from outside,
+  storage           a slot which can hold a media.
+  import/export     the same as above, but is accessible from outside,
                     i.e. there the operator (you !) can use this to
                     fill in and remove media from the changer.
                    Sometimes named "mailslot".
-  data transfer   - this is the device which reads/writes, i.e. the
+  data transfer     this is the device which reads/writes, i.e. the
                    CD-ROM / Tape / whatever drive.
+  ===============   ==================================================
 
 None of these is limited to one: A huge Jukebox could have slots for
 123 CD-ROM's, 5 CD-ROM readers (and therefore 6 SCSI ID's: the changer
@@ -131,24 +135,23 @@ timeout_init=<seconds>
 timeout_move=<seconds>
        timeout for all other commands (default: 120).
 
-dt_id=<id1>,<id2>,...
-dt_lun=<lun1>,<lun2>,...
+dt_id=<id1>,<id2>,... / dt_lun=<lun1>,<lun2>,...
        These two allow to specify the SCSI ID and LUN for the data
        transfer elements.  You likely don't need this as the jukebox
        should provide this information.  But some devices don't ...
 
-vendor_firsts=
-vendor_counts=
-vendor_labels=
+vendor_firsts=, vendor_counts=, vendor_labels=
        These insmod options can be used to tell the driver that there
        are some vendor-specific element types.  Grundig for example
        does this.  Some jukeboxes have a printer to label fresh burned
        CDs, which is addressed as element 0xc000 (type 5).  To tell the
-       driver about this vendor-specific element, use this:
+       driver about this vendor-specific element, use this::
+
                $ insmod ch                     \
                        vendor_firsts=0xc000    \
                        vendor_counts=1         \
                        vendor_labels=printer
+
        All three insmod options accept up to four comma-separated
        values, this way you can configure the element types 5-8.
        You likely need the SCSI specs for the device in question to
@@ -162,13 +165,15 @@ Credits
 I wrote this driver using the famous mailing-patches-around-the-world
 method.  With (more or less) help from:
 
-       Daniel Moehwald <moehwald@hdg.de>
-       Dane Jasper <dane@sonic.net>
-       R. Scott Bailey <sbailey@dsddi.eds.com>
-       Jonathan Corbet <corbet@lwn.net>
+       - Daniel Moehwald <moehwald@hdg.de>
+       - Dane Jasper <dane@sonic.net>
+       - R. Scott Bailey <sbailey@dsddi.eds.com>
+       - Jonathan Corbet <corbet@lwn.net>
 
 Special thanks go to
-       Martin Kuehne <martin.kuehne@bnbt.de>
+
+       - Martin Kuehne <martin.kuehne@bnbt.de>
+
 for a old, second-hand (but full functional) cdrom jukebox which I use
 to develop/test driver and tools now.
 
@@ -176,5 +181,4 @@ Have fun,
 
    Gerd
 
--- 
 Gerd Knorr <kraxel@bytesex.org>

diff --git a/drivers/scsi/Kconfig b/drivers/scsi/Kconfig
index d34c682..6cb9abb 100644 (file)
--- a/drivers/scsi/Kconfig
+++ b/drivers/scsi/Kconfig
@@ -149,7 +149,7 @@ config CHR_DEV_SCH
          don't need this for those tiny 6-slot cdrom changers.  Media
          changers are listed as "Type: Medium Changer" in /proc/scsi/scsi.
          If you have such hardware and want to use it with linux, say Y
-         here.  Check <file:Documentation/scsi/scsi-changer.txt> for details.
+         here.  Check <file:Documentation/scsi/scsi-changer.rst> for details.
        
          If you want to compile this as a module ( = code which can be
          inserted in and removed from the running kernel whenever you want),