scsi: docs: convert link_power_management_policy.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 2 Mar 2020 08:15:53 +0000 (09:15 +0100)
committerMartin K. Petersen <martin.petersen@oracle.com>
Thu, 12 Mar 2020 03:08:00 +0000 (23:08 -0400)
Link: https://lore.kernel.org/r/c56177fdf046d80e0dec6031c4139cb4e8c39d31.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>
Documentation/scsi/index.rst
Documentation/scsi/link_power_management_policy.rst [new file with mode: 0644]
Documentation/scsi/link_power_management_policy.txt [deleted file]

index e6850c0a1378e484d9e8e4d599a9fc5c8d5e2dac..c40050ac3b32c2c72256eb61c9efd6102b281dab 100644 (file)
@@ -24,5 +24,6 @@ Linux SCSI Subsystem
    hpsa
    hptiop
    libsas
+   link_power_management_policy
 
    scsi_transport_srp/figures
diff --git a/Documentation/scsi/link_power_management_policy.rst b/Documentation/scsi/link_power_management_policy.rst
new file mode 100644 (file)
index 0000000..64288dc
--- /dev/null
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+Link Power Managent Policy
+==========================
+
+This parameter allows the user to set the link (interface) power management.
+There are 3 possible options:
+
+=====================   =====================================================
+Value                  Effect
+=====================   =====================================================
+min_power              Tell the controller to try to make the link use the
+                       least possible power when possible.  This may
+                       sacrifice some performance due to increased latency
+                       when coming out of lower power states.
+
+max_performance                Generally, this means no power management.  Tell
+                       the controller to have performance be a priority
+                       over power management.
+
+medium_power           Tell the controller to enter a lower power state
+                       when possible, but do not enter the lowest power
+                       state, thus improving latency over min_power setting.
+=====================   =====================================================
diff --git a/Documentation/scsi/link_power_management_policy.txt b/Documentation/scsi/link_power_management_policy.txt
deleted file mode 100644 (file)
index d18993d..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-This parameter allows the user to set the link (interface) power management.
-There are 3 possible options:
-
-Value                  Effect
-----------------------------------------------------------------------------
-min_power              Tell the controller to try to make the link use the
-                       least possible power when possible.  This may
-                       sacrifice some performance due to increased latency
-                       when coming out of lower power states.
-
-max_performance                Generally, this means no power management.  Tell
-                       the controller to have performance be a priority
-                       over power management.
-
-medium_power           Tell the controller to enter a lower power state
-                       when possible, but do not enter the lowest power
-                       state, thus improving latency over min_power setting.
-
-