linux-kernel - [PATCH 34/42] docs: scsi: convert sd-parameters.txt to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon,  2 Mar 2020 09:16:07 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>
Subject: [PATCH 34/42] docs: scsi: convert sd-parameters.txt to ReST

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
---
 Documentation/scsi/index.rst                  |  1 +
 .../{sd-parameters.txt => sd-parameters.rst}  | 21 ++++++++++++-------
 2 files changed, 14 insertions(+), 8 deletions(-)
 rename Documentation/scsi/{sd-parameters.txt => sd-parameters.rst} (37%)

diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 97276e425f25..6805e157b6e8 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -38,5 +38,6 @@ Linux SCSI Subsystem
    scsi_mid_low_api
    scsi-parameters
    scsi
+   sd-parameters
 
    scsi_transport_srp/figures
diff --git a/Documentation/scsi/sd-parameters.txt b/Documentation/scsi/sd-parameters.rst
similarity index 37%
rename from Documentation/scsi/sd-parameters.txt
rename to Documentation/scsi/sd-parameters.rst
index 8e5af00d88e7..87d554008bfb 100644
--- a/Documentation/scsi/sd-parameters.txt
+++ b/Documentation/scsi/sd-parameters.rst
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================
 Linux SCSI Disk Driver (sd) Parameters
 ======================================
 
@@ -5,18 +8,20 @@ cache_type (RW)
 ---------------
 Enable/disable drive write & read cache.
 
- cache_type string          | WCE RCD | Write cache | Read cache
-----------------------------+---------+-------------+------------
- write through              | 0   0   | off         | on
- none                       | 0   1   | off         | off
- write back                 | 1   0   | on          | on
- write back, no read (daft) | 1   1   | on          | off
+===========================   === ===   ===========   ==========
+ cache_type string            WCE RCD   Write cache   Read cache
+===========================   === ===   ===========   ==========
+ write through                0   0     off           on
+ none                         0   1     off           off
+ write back                   1   0     on            on
+ write back, no read (daft)   1   1     on            off
+===========================   === ===   ===========   ==========
 
-To set cache type to "write back" and save this setting to the drive:
+To set cache type to "write back" and save this setting to the drive::
 
   # echo "write back" > cache_type
 
 To modify the caching mode without making the change persistent, prepend
-"temporary " to the cache type string. E.g.:
+"temporary " to the cache type string. E.g.::
 
   # echo "temporary write back" > cache_type
-- 
2.21.1