[v2,18/24] docs: cpu-freq: convert cpufreq-nforce2.txt to ReST
diff mbox series

Message ID 11b5000d757b77393170edafc02e2c96d9516a52.1581956285.git.mchehab+huawei@kernel.org
State Superseded, archived
Headers show
Series
  • Manually convert thermal, crypto and misc devices to ReST
Related show

Commit Message

Mauro Carvalho Chehab Feb. 17, 2020, 4:20 p.m. UTC
- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Add table markups;
- Add notes markups;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 ...cpufreq-nforce2.txt => cpufreq-nforce2.rst} | 18 ++++++++++++++----
 Documentation/cpu-freq/index.rst               |  1 +
 2 files changed, 15 insertions(+), 4 deletions(-)
 rename Documentation/cpu-freq/{cpufreq-nforce2.txt => cpufreq-nforce2.rst} (55%)

Patch
diff mbox series

diff --git a/Documentation/cpu-freq/cpufreq-nforce2.txt b/Documentation/cpu-freq/cpufreq-nforce2.rst
similarity index 55%
rename from Documentation/cpu-freq/cpufreq-nforce2.txt
rename to Documentation/cpu-freq/cpufreq-nforce2.rst
index babce1315026..aa0ef768a92e 100644
--- a/Documentation/cpu-freq/cpufreq-nforce2.txt
+++ b/Documentation/cpu-freq/cpufreq-nforce2.rst
@@ -1,3 +1,8 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
+nVidia nForce2 Platform Specifics
+=================================
 
 The cpufreq-nforce2 driver changes the FSB on nVidia nForce2 platforms.
 
@@ -6,14 +11,19 @@  can be controlled independently from the PCI/AGP clock.
 
 The module has two options:
 
-	fid: 	 multiplier * 10 (for example 8.5 = 85)
-	min_fsb: minimum FSB
+	=======  ======================================
+	fid 	 multiplier * 10 (for example 8.5 = 85)
+	min_fsb  minimum FSB
+	=======  ======================================
 
 If not set, fid is calculated from the current CPU speed and the FSB.
 min_fsb defaults to FSB at boot time - 50 MHz.
 
-IMPORTANT: The available range is limited downwards!
-           Also the minimum available FSB can differ, for systems 
+.. Important::
+
+           The available range is limited downwards!
+
+           Also the minimum available FSB can differ, for systems
            booting with 200 MHz, 150 should always work.
 
 
diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index 1ab3fff53956..3fa69e6614f6 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -17,6 +17,7 @@  Author: Dominik Brodowski  <linux@brodo.de>
    amd-powernow
    core
    cpu-drivers
+   cpufreq-nforce2
 
 Mailing List
 ------------