linux-pm.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 00/24] Manually convert  thermal, crypto and misc devices to ReST
@ 2020-02-17 16:20 Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
                   ` (7 more replies)
  0 siblings, 8 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Daniel Lezcano,
	David S. Miller, Paul Mackerras, linux-arm-kernel,
	Rafael J. Wysocki, linux-sh, Will Deacon, Amit Daniel Kachhap,
	linux-crypto, Catalin Marinas, keyrings, Viresh Kumar,
	linuxppc-dev, Michael Ellerman, David Howells, linux-pci,
	Herbert Xu, Bjorn Helgaas, Yoshinori Sato, Rich Felker, linux-pm,
	Javi Merino, Dan Williams, Benjamin Herrenschmidt


Manually convert some files from thermal, crypto and misc-devices
to ReST format.

This patch is against linux-next 20200217 tag.

v2: 

- a small change at patch 2 to avoid uneeded whitespace changes;
- added 13 new patches at the end

Mauro Carvalho Chehab (24):
  docs: thermal: convert cpu-idle-cooling.rst to ReST
  docs: crypto: convert asymmetric-keys.txt to ReST
  docs: crypto: convert api-intro.txt to ReST format
  docs: crypto: convert async-tx-api.txt to ReST format
  docs: crypto: descore-readme.txt: convert to ReST format
  docs: misc-devices/spear-pcie-gadget.txt: convert to ReST
  docs: misc-devices/pci-endpoint-test.txt: convert to ReST
  docs: misc-devices/pci-endpoint-test.txt: convert to ReST
  docs: misc-devices/c2port.txt: convert to ReST format
  docs: misc-devices/bh1770glc.txt: convert to ReST
  docs: misc-devices/apds990x.txt: convert to ReST format
  docs: pci: endpoint/function/binding/pci-test.txt convert to ReST
  docs: arm64: convert perf.txt to ReST format
  docs: cpu-freq: convert index.txt to ReST
  docs: cpu-freq: convert amd-powernow.txt to ReST
  docs: cpu-freq: convert core.txt to ReST
  docs: cpu-freq: convert cpu-drivers.txt to ReST
  docs: cpu-freq: convert cpufreq-nforce2.txt to ReST
  docs: cpu-freq: convert cpufreq-stats.txt to ReST
  docs: cpu-freq: convert pcc-cpufreq.txt to ReST
  docs: powerpc: convert vcpudispatch_stats.txt to ReST
  docs: sh: convert new-machine.txt to ReST
  docs: sh: convert register-banks.txt to ReST
  docs: trace: ring-buffer-design.txt: convert to ReST format

 .../endpoint/function/binding/pci-test.rst    |  26 +
 .../endpoint/function/binding/pci-test.txt    |  19 -
 Documentation/PCI/endpoint/index.rst          |   2 +
 Documentation/arm64/index.rst                 |   1 +
 Documentation/arm64/{perf.txt => perf.rst}    |   7 +-
 .../{amd-powernow.txt => amd-powernow.rst}    |  12 +-
 Documentation/cpu-freq/{core.txt => core.rst} |  65 +-
 .../{cpu-drivers.txt => cpu-drivers.rst}      | 129 ++-
 ...pufreq-nforce2.txt => cpufreq-nforce2.rst} |  18 +-
 .../{cpufreq-stats.txt => cpufreq-stats.rst}  | 121 +--
 Documentation/cpu-freq/index.rst              |  42 +
 Documentation/cpu-freq/index.txt              |  56 --
 .../{pcc-cpufreq.txt => pcc-cpufreq.rst}      |  86 +-
 .../crypto/{api-intro.txt => api-intro.rst}   | 186 ++--
 ...symmetric-keys.txt => asymmetric-keys.rst} |  91 +-
 .../{async-tx-api.txt => async-tx-api.rst}    | 253 +++---
 ...{descore-readme.txt => descore-readme.rst} | 152 +++-
 Documentation/crypto/index.rst                |   5 +
 .../driver-api/thermal/cpu-idle-cooling.rst   |  18 +-
 Documentation/driver-api/thermal/index.rst    |   1 +
 Documentation/index.rst                       |   1 +
 .../{ad525x_dpot.txt => ad525x_dpot.rst}      |  24 +-
 .../{apds990x.txt => apds990x.rst}            |  31 +-
 .../{bh1770glc.txt => bh1770glc.rst}          |  45 +-
 .../misc-devices/{c2port.txt => c2port.rst}   |  58 +-
 Documentation/misc-devices/index.rst          |   6 +
 .../misc-devices/pci-endpoint-test.rst        |  56 ++
 .../misc-devices/pci-endpoint-test.txt        |  41 -
 .../misc-devices/spear-pcie-gadget.rst        | 170 ++++
 .../misc-devices/spear-pcie-gadget.txt        | 130 ---
 Documentation/powerpc/index.rst               |   1 +
 ...patch_stats.txt => vcpudispatch_stats.rst} |  17 +-
 Documentation/sh/index.rst                    |   6 +
 .../sh/{new-machine.txt => new-machine.rst}   | 193 +++--
 ...{register-banks.txt => register-banks.rst} |  12 +-
 Documentation/trace/index.rst                 |   1 +
 ...ffer-design.txt => ring-buffer-design.rst} | 802 ++++++++++--------
 37 files changed, 1603 insertions(+), 1281 deletions(-)
 create mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.rst
 delete mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.txt
 rename Documentation/arm64/{perf.txt => perf.rst} (95%)
 rename Documentation/cpu-freq/{amd-powernow.txt => amd-powernow.rst} (89%)
 rename Documentation/cpu-freq/{core.txt => core.rst} (69%)
 rename Documentation/cpu-freq/{cpu-drivers.txt => cpu-drivers.rst} (72%)
 rename Documentation/cpu-freq/{cpufreq-nforce2.txt => cpufreq-nforce2.rst} (55%)
 rename Documentation/cpu-freq/{cpufreq-stats.txt => cpufreq-stats.rst} (53%)
 create mode 100644 Documentation/cpu-freq/index.rst
 delete mode 100644 Documentation/cpu-freq/index.txt
 rename Documentation/cpu-freq/{pcc-cpufreq.txt => pcc-cpufreq.rst} (80%)
 rename Documentation/crypto/{api-intro.txt => api-intro.rst} (70%)
 rename Documentation/crypto/{asymmetric-keys.txt => asymmetric-keys.rst} (91%)
 rename Documentation/crypto/{async-tx-api.txt => async-tx-api.rst} (55%)
 rename Documentation/crypto/{descore-readme.txt => descore-readme.rst} (81%)
 rename Documentation/misc-devices/{ad525x_dpot.txt => ad525x_dpot.rst} (85%)
 rename Documentation/misc-devices/{apds990x.txt => apds990x.rst} (86%)
 rename Documentation/misc-devices/{bh1770glc.txt => bh1770glc.rst} (83%)
 rename Documentation/misc-devices/{c2port.txt => c2port.rst} (59%)
 create mode 100644 Documentation/misc-devices/pci-endpoint-test.rst
 delete mode 100644 Documentation/misc-devices/pci-endpoint-test.txt
 create mode 100644 Documentation/misc-devices/spear-pcie-gadget.rst
 delete mode 100644 Documentation/misc-devices/spear-pcie-gadget.txt
 rename Documentation/powerpc/{vcpudispatch_stats.txt => vcpudispatch_stats.rst} (94%)
 rename Documentation/sh/{new-machine.txt => new-machine.rst} (73%)
 rename Documentation/sh/{register-banks.txt => register-banks.rst} (88%)
 rename Documentation/trace/{ring-buffer-design.txt => ring-buffer-design.rst} (55%)

-- 
2.24.1



^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt " Mauro Carvalho Chehab
                   ` (6 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Amit Daniel Kachhap,
	Daniel Lezcano, Viresh Kumar, Javi Merino, linux-pm

Despite being named with .rst extension, this file doesn't
match the ReST standard. It actually causes a crash at
Sphinx:

	Sphinx parallel build error:
	docutils.utils.SystemMessage: /devel/v4l/docs/Documentation/driver-api/thermal/cpu-idle-cooling.rst:69: (SEVERE/4) Unexpected section title.

Add needed markups for it to be properly parsed.

While here, add it to the thermal index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../driver-api/thermal/cpu-idle-cooling.rst    | 18 ++++++++++++------
 Documentation/driver-api/thermal/index.rst     |  1 +
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Documentation/driver-api/thermal/cpu-idle-cooling.rst b/Documentation/driver-api/thermal/cpu-idle-cooling.rst
index 9f0016ee4cfb..357d2f023605 100644
--- a/Documentation/driver-api/thermal/cpu-idle-cooling.rst
+++ b/Documentation/driver-api/thermal/cpu-idle-cooling.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================
+CPU Idle Cooling
+================
+
 
 Situation:
 ----------
@@ -45,7 +51,7 @@ idle state target residency, we lead to dropping the static and the
 dynamic leakage for this period (modulo the energy needed to enter
 this state). So the sustainable power with idle cycles has a linear
 relation with the OPP’s sustainable power and can be computed with a
-coefficient similar to:
+coefficient similar to::
 
 	    Power(IdleCycle) = Coef x Power(OPP)
 
@@ -136,7 +142,7 @@ Power considerations
 --------------------
 
 When we reach the thermal trip point, we have to sustain a specified
-power for a specific temperature but at this time we consume:
+power for a specific temperature but at this time we consume::
 
  Power = Capacitance x Voltage^2 x Frequency x Utilisation
 
@@ -145,7 +151,7 @@ wrong in the system setup). The ‘Capacitance’ and ‘Utilisation’ are a
 fixed value, ‘Voltage’ and the ‘Frequency’ are fixed artificially
 because we don’t want to change the OPP. We can group the
 ‘Capacitance’ and the ‘Utilisation’ into a single term which is the
-‘Dynamic Power Coefficient (Cdyn)’ Simplifying the above, we have:
+‘Dynamic Power Coefficient (Cdyn)’ Simplifying the above, we have::
 
  Pdyn = Cdyn x Voltage^2 x Frequency
 
@@ -154,7 +160,7 @@ in order to target the sustainable power defined in the device
 tree. So with the idle injection mechanism, we want an average power
 (Ptarget) resulting in an amount of time running at full power on a
 specific OPP and idle another amount of time. That could be put in a
-equation:
+equation::
 
  P(opp)target = ((Trunning x (P(opp)running) + (Tidle x P(opp)idle)) /
 			(Trunning + Tidle)
@@ -165,7 +171,7 @@ equation:
 
 At this point if we know the running period for the CPU, that gives us
 the idle injection we need. Alternatively if we have the idle
-injection duration, we can compute the running duration with:
+injection duration, we can compute the running duration with::
 
  Trunning = Tidle / ((P(opp)running / P(opp)target) - 1)
 
@@ -188,7 +194,7 @@ However, in this demonstration we ignore three aspects:
    target residency, otherwise we end up consuming more energy and
    potentially invert the mitigation effect
 
-So the final equation is:
+So the final equation is::
 
  Trunning = (Tidle - Twakeup ) x
 		(((P(opp)dyn + P(opp)static ) - P(opp)target) / P(opp)target )
diff --git a/Documentation/driver-api/thermal/index.rst b/Documentation/driver-api/thermal/index.rst
index 5ba61d19c6ae..4cb0b9b6bfb8 100644
--- a/Documentation/driver-api/thermal/index.rst
+++ b/Documentation/driver-api/thermal/index.rst
@@ -8,6 +8,7 @@ Thermal
    :maxdepth: 1
 
    cpu-cooling-api
+   cpu-idle-cooling
    sysfs-api
    power_allocator
 
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 20:06   ` Rafael J. Wysocki
  2020-03-02 21:19   ` Jonathan Corbet
  2020-02-17 16:20 ` [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt " Mauro Carvalho Chehab
                   ` (5 subsequent siblings)
  7 siblings, 2 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

most of the stuff there can be re-used with ReST format,
but we need to add an empty TOC and remove the existing
entries, as the following conversion patches will be re-adding
them, as they're converted.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/cpu-freq/index.rst | 35 ++++++++++++++++++++
 Documentation/cpu-freq/index.txt | 56 --------------------------------
 Documentation/index.rst          |  1 +
 3 files changed, 36 insertions(+), 56 deletions(-)
 create mode 100644 Documentation/cpu-freq/index.rst
 delete mode 100644 Documentation/cpu-freq/index.txt

diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
new file mode 100644
index 000000000000..1bff3dfddd23
--- /dev/null
+++ b/Documentation/cpu-freq/index.rst
@@ -0,0 +1,35 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============================================================================
+Linux CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
+==============================================================================
+
+Author: Dominik Brodowski  <linux@brodo.de>
+
+   Clock scaling allows you to change the clock speed of the CPUs on the
+   fly. This is a nice method to save battery power, because the lower
+   the clock speed, the less power the CPU consumes.
+
+
+.. toctree::
+   :maxdepth: 1
+
+Mailing List
+------------
+There is a CPU frequency changing CVS commit and general list where
+you can report bugs, problems or submit patches. To post a message,
+send an email to linux-pm@vger.kernel.org.
+
+Links
+-----
+the FTP archives:
+* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
+
+how to access the CVS repository:
+* http://cvs.arm.linux.org.uk/
+
+the CPUFreq Mailing list:
+* http://vger.kernel.org/vger-lists.html#linux-pm
+
+Clock and voltage scaling for the SA-1100:
+* http://www.lartmaker.nl/projects/scaling
diff --git a/Documentation/cpu-freq/index.txt b/Documentation/cpu-freq/index.txt
deleted file mode 100644
index c15e75386a05..000000000000
--- a/Documentation/cpu-freq/index.txt
+++ /dev/null
@@ -1,56 +0,0 @@
-     CPU frequency and voltage scaling code in the Linux(TM) kernel
-
-
-		         L i n u x    C P U F r e q
-
-
-
-
-		    Dominik Brodowski  <linux@brodo.de>
-
-
-
-   Clock scaling allows you to change the clock speed of the CPUs on the
-    fly. This is a nice method to save battery power, because the lower
-            the clock speed, the less power the CPU consumes.
-
-
-
-Documents in this directory:
-----------------------------
-
-amd-powernow.txt -	AMD powernow driver specific file.
-
-core.txt	-	General description of the CPUFreq core and
-			of CPUFreq notifiers.
-
-cpu-drivers.txt -	How to implement a new cpufreq processor driver.
-
-cpufreq-nforce2.txt -	nVidia nForce2 platform specific file.
-
-cpufreq-stats.txt -	General description of sysfs cpufreq stats.
-
-index.txt	-	File index, Mailing list and Links (this document)
-
-pcc-cpufreq.txt -	PCC cpufreq driver specific file.
-
-
-Mailing List
-------------
-There is a CPU frequency changing CVS commit and general list where
-you can report bugs, problems or submit patches. To post a message,
-send an email to linux-pm@vger.kernel.org.
-
-Links
------
-the FTP archives:
-* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
-
-how to access the CVS repository:
-* http://cvs.arm.linux.org.uk/
-
-the CPUFreq Mailing list:
-* http://vger.kernel.org/vger-lists.html#linux-pm
-
-Clock and voltage scaling for the SA-1100:
-* http://www.lartmaker.nl/projects/scaling
diff --git a/Documentation/index.rst b/Documentation/index.rst
index e99d0bd2589d..4cf37ad1cd1d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -99,6 +99,7 @@ needed).
    accounting/index
    block/index
    cdrom/index
+   cpu-freq/index
    ide/index
    fb/index
    fpga/index
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 16/24] docs: cpu-freq: convert core.txt " Mauro Carvalho Chehab
                   ` (4 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../cpu-freq/{amd-powernow.txt => amd-powernow.rst}  | 12 ++++++++++--
 Documentation/cpu-freq/index.rst                     |  2 ++
 2 files changed, 12 insertions(+), 2 deletions(-)
 rename Documentation/cpu-freq/{amd-powernow.txt => amd-powernow.rst} (89%)

diff --git a/Documentation/cpu-freq/amd-powernow.txt b/Documentation/cpu-freq/amd-powernow.rst
similarity index 89%
rename from Documentation/cpu-freq/amd-powernow.txt
rename to Documentation/cpu-freq/amd-powernow.rst
index 254da155fa47..4a53612b62a2 100644
--- a/Documentation/cpu-freq/amd-powernow.txt
+++ b/Documentation/cpu-freq/amd-powernow.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================
+AMD PowerNow Driver Specifics
+=============================
+
 
 PowerNow! and Cool'n'Quiet are AMD names for frequency
 management capabilities in AMD processors. As the hardware
@@ -23,16 +29,18 @@ not supply these tables.
 7th Generation: powernow-k7: Athlon, Duron, Geode.
 
 8th Generation: powernow-k8: Athlon, Athlon 64, Opteron, Sempron.
+
 Documentation on this functionality in 8th generation processors
 is available in the "BIOS and Kernel Developer's Guide", publication
-26094, in chapter 9, available for download from www.amd.com. 
+26094, in chapter 9, available for download from www.amd.com.
 
 BIOS supplied data, for powernow-k7 and for powernow-k8, may be
 from either the PSB table or from ACPI objects. The ACPI support
 is only available if the kernel config sets CONFIG_ACPI_PROCESSOR.
 The powernow-k8 driver will attempt to use ACPI if so configured,
 and fall back to PST if that fails.
+
 The powernow-k7 driver will try to use the PSB support first, and
 fall back to ACPI if the PSB support fails. A module parameter,
-acpi_force, is provided to force ACPI support to be used instead 
+acpi_force, is provided to force ACPI support to be used instead
 of PSB support.
diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index 1bff3dfddd23..6f7c2a024447 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -14,6 +14,8 @@ Author: Dominik Brodowski  <linux@brodo.de>
 .. toctree::
    :maxdepth: 1
 
+   amd-powernow
+
 Mailing List
 ------------
 There is a CPU frequency changing CVS commit and general list where
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 16/24] docs: cpu-freq: convert core.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  2020-02-17 16:20 ` [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt " Mauro Carvalho Chehab
                   ` (3 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- Add a SPDX header;
- Adjust the  document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- use ``foo`` to mark a literal expression with asterisk;
- Adjust some title marks;
- Add table markups;
- Add notes markups;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/cpu-freq/{core.txt => core.rst} | 65 ++++++++++---------
 Documentation/cpu-freq/index.rst              |  1 +
 2 files changed, 34 insertions(+), 32 deletions(-)
 rename Documentation/cpu-freq/{core.txt => core.rst} (69%)

diff --git a/Documentation/cpu-freq/core.txt b/Documentation/cpu-freq/core.rst
similarity index 69%
rename from Documentation/cpu-freq/core.txt
rename to Documentation/cpu-freq/core.rst
index ed577d9c154b..33cb90bd1d8f 100644
--- a/Documentation/cpu-freq/core.txt
+++ b/Documentation/cpu-freq/core.rst
@@ -1,31 +1,23 @@
-     CPU frequency and voltage scaling code in the Linux(TM) kernel
+.. SPDX-License-Identifier: GPL-2.0
 
+=============================================================
+General description of the CPUFreq core and CPUFreq notifiers
+=============================================================
 
-		         L i n u x    C P U F r e q
+Authors:
+	- Dominik Brodowski  <linux@brodo.de>
+	- David Kimdon <dwhedon@debian.org>
+	- Rafael J. Wysocki <rafael.j.wysocki@intel.com>
+	- Viresh Kumar <viresh.kumar@linaro.org>
 
-			  C P U F r e q    C o r e
+.. Contents:
 
-
-		    Dominik Brodowski  <linux@brodo.de>
-		     David Kimdon <dwhedon@debian.org>
-		Rafael J. Wysocki <rafael.j.wysocki@intel.com>
-		   Viresh Kumar <viresh.kumar@linaro.org>
-
-
-
-   Clock scaling allows you to change the clock speed of the CPUs on the
-    fly. This is a nice method to save battery power, because the lower
-            the clock speed, the less power the CPU consumes.
-
-
-Contents:
----------
-1.  CPUFreq core and interfaces
-2.  CPUFreq notifiers
-3.  CPUFreq Table Generation with Operating Performance Point (OPP)
+   1.  CPUFreq core and interfaces
+   2.  CPUFreq notifiers
+   3.  CPUFreq Table Generation with Operating Performance Point (OPP)
 
 1. General Information
-=======================
+======================
 
 The CPUFreq core code is located in drivers/cpufreq/cpufreq.c. This
 cpufreq code offers a standardized interface for the CPUFreq
@@ -63,7 +55,7 @@ The phase is specified in the second argument to the notifier.  The phase is
 CPUFREQ_CREATE_POLICY when the policy is first created and it is
 CPUFREQ_REMOVE_POLICY when the policy is removed.
 
-The third argument, a void *pointer, points to a struct cpufreq_policy
+The third argument, a ``void *pointer``, points to a struct cpufreq_policy
 consisting of several values, including min, max (the lower and upper
 frequencies (in kHz) of the new policy).
 
@@ -80,10 +72,13 @@ CPUFREQ_POSTCHANGE.
 
 The third argument is a struct cpufreq_freqs with the following
 values:
-cpu	- number of the affected CPU
-old	- old frequency
-new	- new frequency
-flags	- flags of the cpufreq driver
+
+=====	===========================
+cpu	number of the affected CPU
+old	old frequency
+new	new frequency
+flags	flags of the cpufreq driver
+=====	===========================
 
 3. CPUFreq Table Generation with Operating Performance Point (OPP)
 ==================================================================
@@ -94,9 +89,12 @@ dev_pm_opp_init_cpufreq_table -
 	the OPP layer's internal information about the available frequencies
 	into a format readily providable to cpufreq.
 
-	WARNING: Do not use this function in interrupt context.
+	.. Warning::
+
+	   Do not use this function in interrupt context.
+
+	Example::
 
-	Example:
 	 soc_pm_init()
 	 {
 		/* Do things */
@@ -106,7 +104,10 @@ dev_pm_opp_init_cpufreq_table -
 		/* Do other things */
 	 }
 
-	NOTE: This function is available only if CONFIG_CPU_FREQ is enabled in
-	addition to CONFIG_PM_OPP.
+	.. note::
 
-dev_pm_opp_free_cpufreq_table - Free up the table allocated by dev_pm_opp_init_cpufreq_table
+	   This function is available only if CONFIG_CPU_FREQ is enabled in
+	   addition to CONFIG_PM_OPP.
+
+dev_pm_opp_free_cpufreq_table
+	Free up the table allocated by dev_pm_opp_init_cpufreq_table
diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index 6f7c2a024447..8babc5a212dd 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -15,6 +15,7 @@ Author: Dominik Brodowski  <linux@brodo.de>
    :maxdepth: 1
 
    amd-powernow
+   core
 
 Mailing List
 ------------
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
                   ` (3 preceding siblings ...)
  2020-02-17 16:20 ` [PATCH v2 16/24] docs: cpu-freq: convert core.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt " Mauro Carvalho Chehab
                   ` (2 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- Adjust some title marks;
- Add table markups;
- Add notes markups;
- Mark literal blocks as such;
- use ``foo`` for literal texts;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../{cpu-drivers.txt => cpu-drivers.rst}      | 129 +++++++++---------
 Documentation/cpu-freq/index.rst              |   1 +
 2 files changed, 64 insertions(+), 66 deletions(-)
 rename Documentation/cpu-freq/{cpu-drivers.txt => cpu-drivers.rst} (72%)

diff --git a/Documentation/cpu-freq/cpu-drivers.txt b/Documentation/cpu-freq/cpu-drivers.rst
similarity index 72%
rename from Documentation/cpu-freq/cpu-drivers.txt
rename to Documentation/cpu-freq/cpu-drivers.rst
index 6e353d00cdc6..a697278ce190 100644
--- a/Documentation/cpu-freq/cpu-drivers.txt
+++ b/Documentation/cpu-freq/cpu-drivers.rst
@@ -1,35 +1,27 @@
-     CPU frequency and voltage scaling code in the Linux(TM) kernel
+.. SPDX-License-Identifier: GPL-2.0
 
+===============================================
+How to Implement a new CPUFreq Processor Driver
+===============================================
 
-		         L i n u x    C P U F r e q
+Authors:
 
-			   C P U   D r i v e r s 
 
-		       - information for developers -
+	- Dominik Brodowski  <linux@brodo.de>
+	- Rafael J. Wysocki <rafael.j.wysocki@intel.com>
+	- Viresh Kumar <viresh.kumar@linaro.org>
 
+.. Contents
 
-		    Dominik Brodowski  <linux@brodo.de>
-		Rafael J. Wysocki <rafael.j.wysocki@intel.com>
-		   Viresh Kumar <viresh.kumar@linaro.org>
-
-
-
-   Clock scaling allows you to change the clock speed of the CPUs on the
-    fly. This is a nice method to save battery power, because the lower
-            the clock speed, the less power the CPU consumes.
-
-
-Contents:
----------
-1.   What To Do?
-1.1  Initialization
-1.2  Per-CPU Initialization
-1.3  verify
-1.4  target/target_index or setpolicy?
-1.5  target/target_index
-1.6  setpolicy
-1.7  get_intermediate and target_intermediate
-2.   Frequency Table Helpers
+   1.   What To Do?
+   1.1  Initialization
+   1.2  Per-CPU Initialization
+   1.3  verify
+   1.4  target/target_index or setpolicy?
+   1.5  target/target_index
+   1.6  setpolicy
+   1.7  get_intermediate and target_intermediate
+   2.   Frequency Table Helpers
 
 
 
@@ -49,7 +41,7 @@ function check whether this kernel runs on the right CPU and the right
 chipset. If so, register a struct cpufreq_driver with the CPUfreq core
 using cpufreq_register_driver()
 
-What shall this struct cpufreq_driver contain? 
+What shall this struct cpufreq_driver contain?
 
  .name - The name of this driver.
 
@@ -108,37 +100,42 @@ Whenever a new CPU is registered with the device model, or after the
 cpufreq driver registers itself, the per-policy initialization function
 cpufreq_driver.init is called if no cpufreq policy existed for the CPU.
 Note that the .init() and .exit() routines are called only once for the
-policy and not for each CPU managed by the policy. It takes a struct
-cpufreq_policy *policy as argument. What to do now?
+policy and not for each CPU managed by the policy. It takes a ``struct
+cpufreq_policy *policy`` as argument. What to do now?
 
 If necessary, activate the CPUfreq support on your CPU.
 
 Then, the driver must fill in the following values:
 
-policy->cpuinfo.min_freq _and_
-policy->cpuinfo.max_freq -	the minimum and maximum frequency 
-				(in kHz) which is supported by 
-				this CPU
-policy->cpuinfo.transition_latency   the time it takes on this CPU to
-				switch between two frequencies in
-				nanoseconds (if appropriate, else
-				specify CPUFREQ_ETERNAL)
-
-policy->cur			The current operating frequency of
-				this CPU (if appropriate)
-policy->min, 
-policy->max, 
-policy->policy and, if necessary,
-policy->governor		must contain the "default policy" for
-				this CPU. A few moments later,
-				cpufreq_driver.verify and either
-				cpufreq_driver.setpolicy or
-				cpufreq_driver.target/target_index is called
-				with these values.
-policy->cpus			Update this with the masks of the
-				(online + offline) CPUs that do DVFS
-				along with this CPU (i.e.  that share
-				clock/voltage rails with it).
++-----------------------------------+--------------------------------------+
+|policy->cpuinfo.min_freq _and_	    |					   |
+|policy->cpuinfo.max_freq	    | the minimum and maximum frequency	   |
+|				    | (in kHz) which is supported by	   |
+|				    | this CPU				   |
++-----------------------------------+--------------------------------------+
+|policy->cpuinfo.transition_latency | the time it takes on this CPU to	   |
+|				    | switch between two frequencies in	   |
+|				    | nanoseconds (if appropriate, else	   |
+|				    | specify CPUFREQ_ETERNAL)		   |
++-----------------------------------+--------------------------------------+
+|policy->cur			    | The current operating frequency of   |
+|				    | this CPU (if appropriate)		   |
++-----------------------------------+--------------------------------------+
+|policy->min,			    |					   |
+|policy->max,			    |					   |
+|policy->policy and, if necessary,  |					   |
+|policy->governor		    | must contain the "default policy" for|
+|				    | this CPU. A few moments later,       |
+|				    | cpufreq_driver.verify and either     |
+|				    | cpufreq_driver.setpolicy or          |
+|				    | cpufreq_driver.target/target_index is|
+|				    | called with these values.		   |
++-----------------------------------+--------------------------------------+
+|policy->cpus			    | Update this with the masks of the	   |
+|				    | (online + offline) CPUs that do DVFS |
+|				    | along with this CPU (i.e.  that share|
+|				    | clock/voltage rails with it).	   |
++-----------------------------------+--------------------------------------+
 
 For setting some of these values (cpuinfo.min[max]_freq, policy->min[max]), the
 frequency table helpers might be helpful. See the section 2 for more information
@@ -151,8 +148,8 @@ on them.
 When the user decides a new policy (consisting of
 "policy,governor,min,max") shall be set, this policy must be validated
 so that incompatible values can be corrected. For verifying these
-values cpufreq_verify_within_limits(struct cpufreq_policy *policy,
-unsigned int min_freq, unsigned int max_freq) function might be helpful.
+values cpufreq_verify_within_limits(``struct cpufreq_policy *policy``,
+``unsigned int min_freq``, ``unsigned int max_freq``) function might be helpful.
 See section 2 for details on frequency table helpers.
 
 You need to make sure that at least one valid frequency (or operating
@@ -163,7 +160,7 @@ policy->max first, and only if this is no solution, decrease policy->min.
 1.4 target or target_index or setpolicy or fast_switch?
 -------------------------------------------------------
 
-Most cpufreq drivers or even most cpu frequency scaling algorithms 
+Most cpufreq drivers or even most cpu frequency scaling algorithms
 only allow the CPU frequency to be set to predefined fixed values. For
 these, you use the ->target(), ->target_index() or ->fast_switch()
 callbacks.
@@ -175,8 +172,8 @@ limits on their own. These shall use the ->setpolicy() callback.
 1.5. target/target_index
 ------------------------
 
-The target_index call has two arguments: struct cpufreq_policy *policy,
-and unsigned int index (into the exposed frequency table).
+The target_index call has two arguments: ``struct cpufreq_policy *policy``,
+and ``unsigned int`` index (into the exposed frequency table).
 
 The CPUfreq driver must set the new frequency when called here. The
 actual frequency must be determined by freq_table[index].frequency.
@@ -184,9 +181,9 @@ actual frequency must be determined by freq_table[index].frequency.
 It should always restore to earlier frequency (i.e. policy->restore_freq) in
 case of errors, even if we switched to intermediate frequency earlier.
 
-Deprecated:
+Deprecated
 ----------
-The target call has three arguments: struct cpufreq_policy *policy,
+The target call has three arguments: ``struct cpufreq_policy *policy``,
 unsigned int target_frequency, unsigned int relation.
 
 The CPUfreq driver must set the new frequency when called here. The
@@ -210,14 +207,14 @@ Not all drivers are expected to implement it, as sleeping from within
 this callback isn't allowed. This callback must be highly optimized to
 do switching as fast as possible.
 
-This function has two arguments: struct cpufreq_policy *policy and
-unsigned int target_frequency.
+This function has two arguments: ``struct cpufreq_policy *policy`` and
+``unsigned int target_frequency``.
 
 
 1.7 setpolicy
 -------------
 
-The setpolicy call only takes a struct cpufreq_policy *policy as
+The setpolicy call only takes a ``struct cpufreq_policy *policy`` as
 argument. You need to set the lower limit of the in-processor or
 in-chipset dynamic frequency switching to policy->min, the upper limit
 to policy->max, and -if supported- select a performance-oriented
@@ -278,10 +275,10 @@ table.
 
 cpufreq_for_each_valid_entry(pos, table) - iterates over all entries,
 excluding CPUFREQ_ENTRY_INVALID frequencies.
-Use arguments "pos" - a cpufreq_frequency_table * as a loop cursor and
-"table" - the cpufreq_frequency_table * you want to iterate over.
+Use arguments "pos" - a ``cpufreq_frequency_table *`` as a loop cursor and
+"table" - the ``cpufreq_frequency_table *`` you want to iterate over.
 
-For example:
+For example::
 
 	struct cpufreq_frequency_table *pos, *driver_freq_table;
 
diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index 8babc5a212dd..1ab3fff53956 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -16,6 +16,7 @@ Author: Dominik Brodowski  <linux@brodo.de>
 
    amd-powernow
    core
+   cpu-drivers
 
 Mailing List
 ------------
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
                   ` (4 preceding siblings ...)
  2020-02-17 16:20 ` [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt " Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt " Mauro Carvalho Chehab
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- 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%)

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
 ------------
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
                   ` (5 preceding siblings ...)
  2020-02-17 16:20 ` [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  2020-02-17 16:20 ` [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt " Mauro Carvalho Chehab
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- Adjust some title marks;
- Use bold on some places;
- Mark literal blocks as such;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

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

diff --git a/Documentation/cpu-freq/cpufreq-stats.txt b/Documentation/cpu-freq/cpufreq-stats.rst
similarity index 53%
rename from Documentation/cpu-freq/cpufreq-stats.txt
rename to Documentation/cpu-freq/cpufreq-stats.rst
index 14378cecb172..9ad695b1c7db 100644
--- a/Documentation/cpu-freq/cpufreq-stats.txt
+++ b/Documentation/cpu-freq/cpufreq-stats.rst
@@ -1,21 +1,23 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-     CPU frequency and voltage scaling statistics in the Linux(TM) kernel
+==========================================
+General Description of sysfs CPUFreq Stats
+==========================================
 
+information for users
 
-             L i n u x    c p u f r e q - s t a t s   d r i v e r
 
-                       - information for users -
+Author: Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
 
+.. Contents
 
-             Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
-
-Contents
-1. Introduction
-2. Statistics Provided (with example)
-3. Configuring cpufreq-stats
+   1. Introduction
+   2. Statistics Provided (with example)
+   3. Configuring cpufreq-stats
 
 
 1. Introduction
+===============
 
 cpufreq-stats is a driver that provides CPU frequency statistics for each CPU.
 These statistics are provided in /sysfs as a bunch of read_only interfaces. This
@@ -28,8 +30,10 @@ that may be running on your CPU. So, it will work with any cpufreq_driver.
 
 
 2. Statistics Provided (with example)
+=====================================
 
 cpufreq stats provides following statistics (explained in detail below).
+
 -  time_in_state
 -  total_trans
 -  trans_table
@@ -39,53 +43,57 @@ All the statistics will be from the time the stats driver has been inserted
 statistic is done. Obviously, stats driver will not have any information
 about the frequency transitions before the stats driver insertion.
 
---------------------------------------------------------------------------------
-<mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # ls -l
-total 0
-drwxr-xr-x  2 root root    0 May 14 16:06 .
-drwxr-xr-x  3 root root    0 May 14 15:58 ..
---w-------  1 root root 4096 May 14 16:06 reset
--r--r--r--  1 root root 4096 May 14 16:06 time_in_state
--r--r--r--  1 root root 4096 May 14 16:06 total_trans
--r--r--r--  1 root root 4096 May 14 16:06 trans_table
---------------------------------------------------------------------------------
+::
+
+    <mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # ls -l
+    total 0
+    drwxr-xr-x  2 root root    0 May 14 16:06 .
+    drwxr-xr-x  3 root root    0 May 14 15:58 ..
+    --w-------  1 root root 4096 May 14 16:06 reset
+    -r--r--r--  1 root root 4096 May 14 16:06 time_in_state
+    -r--r--r--  1 root root 4096 May 14 16:06 total_trans
+    -r--r--r--  1 root root 4096 May 14 16:06 trans_table
+
+- **reset**
 
--  reset
 Write-only attribute that can be used to reset the stat counters. This can be
 useful for evaluating system behaviour under different governors without the
 need for a reboot.
 
--  time_in_state
+- **time_in_state**
+
 This gives the amount of time spent in each of the frequencies supported by
 this CPU. The cat output will have "<frequency> <time>" pair in each line, which
 will mean this CPU spent <time> usertime units of time at <frequency>. Output
-will have one line for each of the supported frequencies. usertime units here 
+will have one line for each of the supported frequencies. usertime units here
 is 10mS (similar to other time exported in /proc).
 
---------------------------------------------------------------------------------
-<mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat time_in_state 
-3600000 2089
-3400000 136
-3200000 34
-3000000 67
-2800000 172488
---------------------------------------------------------------------------------
-
-
--  total_trans
-This gives the total number of frequency transitions on this CPU. The cat 
+::
+
+    <mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat time_in_state
+    3600000 2089
+    3400000 136
+    3200000 34
+    3000000 67
+    2800000 172488
+
+
+- **total_trans**
+
+This gives the total number of frequency transitions on this CPU. The cat
 output will have a single count which is the total number of frequency
 transitions.
 
---------------------------------------------------------------------------------
-<mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat total_trans
-20
---------------------------------------------------------------------------------
+::
+
+    <mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat total_trans
+    20
+
+- **trans_table**
 
--  trans_table
 This will give a fine grained information about all the CPU frequency
 transitions. The cat output here is a two dimensional matrix, where an entry
-<i,j> (row i, column j) represents the count of number of transitions from 
+<i,j> (row i, column j) represents the count of number of transitions from
 Freq_i to Freq_j. Freq_i rows and Freq_j columns follow the sorting order in
 which the driver has provided the frequency table initially to the cpufreq core
 and so can be sorted (ascending or descending) or unsorted.  The output here
@@ -95,26 +103,27 @@ readability.
 If the transition table is bigger than PAGE_SIZE, reading this will
 return an -EFBIG error.
 
---------------------------------------------------------------------------------
-<mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat trans_table
-   From  :    To
-         :   3600000   3400000   3200000   3000000   2800000 
-  3600000:         0         5         0         0         0 
-  3400000:         4         0         2         0         0 
-  3200000:         0         1         0         2         0 
-  3000000:         0         0         1         0         3 
-  2800000:         0         0         0         2         0 
---------------------------------------------------------------------------------
+::
 
+    <mysystem>:/sys/devices/system/cpu/cpu0/cpufreq/stats # cat trans_table
+    From  :    To
+	    :   3600000   3400000   3200000   3000000   2800000
+    3600000:         0         5         0         0         0
+    3400000:         4         0         2         0         0
+    3200000:         0         1         0         2         0
+    3000000:         0         0         1         0         3
+    2800000:         0         0         0         2         0
 
 3. Configuring cpufreq-stats
+============================
 
-To configure cpufreq-stats in your kernel
-Config Main Menu
-	Power management options (ACPI, APM)  --->
-		CPU Frequency scaling  --->
-			[*] CPU Frequency scaling
-			[*]   CPU frequency translation statistics
+To configure cpufreq-stats in your kernel::
+
+	Config Main Menu
+		Power management options (ACPI, APM)  --->
+			CPU Frequency scaling  --->
+				[*] CPU Frequency scaling
+				[*]   CPU frequency translation statistics
 
 
 "CPU Frequency scaling" (CONFIG_CPU_FREQ) should be enabled to configure
diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index 3fa69e6614f6..d12ef0bb78a5 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -18,6 +18,7 @@ Author: Dominik Brodowski  <linux@brodo.de>
    core
    cpu-drivers
    cpufreq-nforce2
+   cpufreq-stats
 
 Mailing List
 ------------
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt to ReST
  2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
                   ` (6 preceding siblings ...)
  2020-02-17 16:20 ` [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt " Mauro Carvalho Chehab
@ 2020-02-17 16:20 ` Mauro Carvalho Chehab
  7 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:20 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, linux-pm

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Add copyright symbol;
- Remove a c-like comment, adding the useful info not covered
  by the SPDX and document title headers as text;
- Comment out the existing text-only index;
- Mark literal blocks as such;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

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

diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
index d12ef0bb78a5..fb2db2eb7eaf 100644
--- a/Documentation/cpu-freq/index.rst
+++ b/Documentation/cpu-freq/index.rst
@@ -19,6 +19,7 @@ Author: Dominik Brodowski  <linux@brodo.de>
    cpu-drivers
    cpufreq-nforce2
    cpufreq-stats
+   pcc-cpufreq
 
 Mailing List
 ------------
diff --git a/Documentation/cpu-freq/pcc-cpufreq.txt b/Documentation/cpu-freq/pcc-cpufreq.rst
similarity index 80%
rename from Documentation/cpu-freq/pcc-cpufreq.txt
rename to Documentation/cpu-freq/pcc-cpufreq.rst
index 9e3c3b33514c..6fd891f757a7 100644
--- a/Documentation/cpu-freq/pcc-cpufreq.txt
+++ b/Documentation/cpu-freq/pcc-cpufreq.rst
@@ -1,45 +1,29 @@
-/*
- *  pcc-cpufreq.txt - PCC interface documentation
- *
- *  Copyright (C) 2009 Red Hat, Matthew Garrett <mjg@redhat.com>
- *  Copyright (C) 2009 Hewlett-Packard Development Company, L.P.
- *      Nagananda Chumbalkar <nagananda.chumbalkar@hp.com>
- *
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; version 2 of the License.
- *
- *  This program is distributed in the hope that it will be useful, but
- *  WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or NON
- *  INFRINGEMENT. See the GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License along
- *  with this program; if not, write to the Free Software Foundation, Inc.,
- *  675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- */
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
 
+=========================================================
+Processor Clocking Control (PCC) CPUFreq Driver Specifics
+=========================================================
 
-			Processor Clocking Control Driver
-			---------------------------------
+Copyright |copy| 2009 Red Hat, Matthew Garrett <mjg@redhat.com>
 
-Contents:
----------
-1.	Introduction
-1.1	PCC interface
-1.1.1   Get Average Frequency
-1.1.2	Set Desired Frequency
-1.2	Platforms affected
-2.	Driver and /sys details
-2.1	scaling_available_frequencies
-2.2	cpuinfo_transition_latency
-2.3	cpuinfo_cur_freq
-2.4	related_cpus
-3.	Caveats
+Copyright |copy| 2009 Hewlett-Packard Development Company, L.P.,
+Nagananda Chumbalkar <nagananda.chumbalkar@hp.com>
+
+
+.. Contents:
+
+   1.	Introduction
+   1.1	PCC interface
+   1.1.1   Get Average Frequency
+   1.1.2	Set Desired Frequency
+   1.2	Platforms affected
+   2.	Driver and /sys details
+   2.1	scaling_available_frequencies
+   2.2	cpuinfo_transition_latency
+   2.3	cpuinfo_cur_freq
+   2.4	related_cpus
+   3.	Caveats
 
 1. Introduction:
 ----------------
@@ -140,7 +124,9 @@ Internally, there is no need for the driver to convert the "target" frequency
 to a corresponding P-state.
 
 The VERSION number for the driver will be of the format v.xy.ab.
-eg: 1.00.02
+eg::
+
+   1.00.02
    ----- --
     |    |
     |    -- this will increase with bug fixes/enhancements to the driver
@@ -168,21 +154,21 @@ A) Often cpuinfo_cur_freq will show a value different than what is declared
 in the scaling_available_frequencies or scaling_cur_freq, or scaling_max_freq.
 This is due to "turbo boost" available on recent Intel processors. If certain
 conditions are met the BIOS can achieve a slightly higher speed than requested
-by OSPM. An example:
+by OSPM. An example::
 
-scaling_cur_freq	: 2933000
-cpuinfo_cur_freq	: 3196000
+	scaling_cur_freq	: 2933000
+	cpuinfo_cur_freq	: 3196000
 
 B) There is a round-off error associated with the cpuinfo_cur_freq value.
 Since the driver obtains the current frequency as a "percentage" (%) of the
 nominal frequency from the BIOS, sometimes, the values displayed by
-scaling_cur_freq and cpuinfo_cur_freq may not match. An example:
+scaling_cur_freq and cpuinfo_cur_freq may not match. An example::
 
-scaling_cur_freq	: 1600000
-cpuinfo_cur_freq	: 1583000
+	scaling_cur_freq	: 1600000
+	cpuinfo_cur_freq	: 1583000
 
 In this example, the nominal frequency is 2933 MHz. The driver obtains the
-current frequency, cpuinfo_cur_freq, as 54% of the nominal frequency:
+current frequency, cpuinfo_cur_freq, as 54% of the nominal frequency::
 
 	54% of 2933 MHz = 1583 MHz
 
@@ -193,8 +179,10 @@ corresponds to the frequency of the P0 P-state.
 -----------------
 The related_cpus field is identical to affected_cpus.
 
-affected_cpus	: 4
-related_cpus	: 4
+::
+
+	affected_cpus	: 4
+	related_cpus	: 4
 
 Currently, the PCC driver does not evaluate _PSD. The platforms that support
 PCC do not implement SW_ALL. So OSPM doesn't need to perform any coordination
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt " Mauro Carvalho Chehab
@ 2020-02-17 20:06   ` Rafael J. Wysocki
  2020-02-28  9:14     ` Mauro Carvalho Chehab
  2020-03-02 21:19   ` Jonathan Corbet
  1 sibling, 1 reply; 16+ messages in thread
From: Rafael J. Wysocki @ 2020-02-17 20:06 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Jonathan Corbet, Rafael J. Wysocki,
	Viresh Kumar, Linux PM

On Mon, Feb 17, 2020 at 5:20 PM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> most of the stuff there can be re-used with ReST format,
> but we need to add an empty TOC and remove the existing
> entries, as the following conversion patches will be re-adding
> them, as they're converted.

I see a very little value in converting the files in the cpu-freq
directory from .txt to .rst, which I have told you at least twice.

They are just old-style driver API documents for cpufreq, but moving
them under driver-api/ as they are would not be a good idea IMO,
because at least some of them are outdated (note that the admin-guide
part of the cpufreq documentation, in the .rst format, is located
under admin-guide/).

I haven't had the time to write a proper replacement for them yet and
honestly I find it quite obnoxious to see these reoccurring attempts
to blindly convert them to .rst without taking care of their contents
and location.

I will take care of these files at one point as promised, but that's
not going to happen today or tomorrow and please just leave them alone
if that is not a big deal.

Thanks!

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/cpu-freq/index.rst | 35 ++++++++++++++++++++
>  Documentation/cpu-freq/index.txt | 56 --------------------------------
>  Documentation/index.rst          |  1 +
>  3 files changed, 36 insertions(+), 56 deletions(-)
>  create mode 100644 Documentation/cpu-freq/index.rst
>  delete mode 100644 Documentation/cpu-freq/index.txt
>
> diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
> new file mode 100644
> index 000000000000..1bff3dfddd23
> --- /dev/null
> +++ b/Documentation/cpu-freq/index.rst
> @@ -0,0 +1,35 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==============================================================================
> +Linux CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
> +==============================================================================
> +
> +Author: Dominik Brodowski  <linux@brodo.de>
> +
> +   Clock scaling allows you to change the clock speed of the CPUs on the
> +   fly. This is a nice method to save battery power, because the lower
> +   the clock speed, the less power the CPU consumes.
> +
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +Mailing List
> +------------
> +There is a CPU frequency changing CVS commit and general list where
> +you can report bugs, problems or submit patches. To post a message,
> +send an email to linux-pm@vger.kernel.org.
> +
> +Links
> +-----
> +the FTP archives:
> +* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
> +
> +how to access the CVS repository:
> +* http://cvs.arm.linux.org.uk/
> +
> +the CPUFreq Mailing list:
> +* http://vger.kernel.org/vger-lists.html#linux-pm
> +
> +Clock and voltage scaling for the SA-1100:
> +* http://www.lartmaker.nl/projects/scaling
> diff --git a/Documentation/cpu-freq/index.txt b/Documentation/cpu-freq/index.txt
> deleted file mode 100644
> index c15e75386a05..000000000000
> --- a/Documentation/cpu-freq/index.txt
> +++ /dev/null
> @@ -1,56 +0,0 @@
> -     CPU frequency and voltage scaling code in the Linux(TM) kernel
> -
> -
> -                        L i n u x    C P U F r e q
> -
> -
> -
> -
> -                   Dominik Brodowski  <linux@brodo.de>
> -
> -
> -
> -   Clock scaling allows you to change the clock speed of the CPUs on the
> -    fly. This is a nice method to save battery power, because the lower
> -            the clock speed, the less power the CPU consumes.
> -
> -
> -
> -Documents in this directory:
> -----------------------------
> -
> -amd-powernow.txt -     AMD powernow driver specific file.
> -
> -core.txt       -       General description of the CPUFreq core and
> -                       of CPUFreq notifiers.
> -
> -cpu-drivers.txt -      How to implement a new cpufreq processor driver.
> -
> -cpufreq-nforce2.txt -  nVidia nForce2 platform specific file.
> -
> -cpufreq-stats.txt -    General description of sysfs cpufreq stats.
> -
> -index.txt      -       File index, Mailing list and Links (this document)
> -
> -pcc-cpufreq.txt -      PCC cpufreq driver specific file.
> -
> -
> -Mailing List
> -------------
> -There is a CPU frequency changing CVS commit and general list where
> -you can report bugs, problems or submit patches. To post a message,
> -send an email to linux-pm@vger.kernel.org.
> -
> -Links
> ------
> -the FTP archives:
> -* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
> -
> -how to access the CVS repository:
> -* http://cvs.arm.linux.org.uk/
> -
> -the CPUFreq Mailing list:
> -* http://vger.kernel.org/vger-lists.html#linux-pm
> -
> -Clock and voltage scaling for the SA-1100:
> -* http://www.lartmaker.nl/projects/scaling
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index e99d0bd2589d..4cf37ad1cd1d 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -99,6 +99,7 @@ needed).
>     accounting/index
>     block/index
>     cdrom/index
> +   cpu-freq/index
>     ide/index
>     fb/index
>     fpga/index
> --
> 2.24.1
>

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-02-17 20:06   ` Rafael J. Wysocki
@ 2020-02-28  9:14     ` Mauro Carvalho Chehab
  2020-02-28  9:33       ` Rafael J. Wysocki
  0 siblings, 1 reply; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-28  9:14 UTC (permalink / raw)
  To: Rafael J. Wysocki
  Cc: Linux Doc Mailing List, Jonathan Corbet, Viresh Kumar, Linux PM

Hi Rafael,

Em Mon, 17 Feb 2020 21:06:20 +0100
"Rafael J. Wysocki" <rafael@kernel.org> escreveu:

> On Mon, Feb 17, 2020 at 5:20 PM Mauro Carvalho Chehab
> <mchehab+huawei@kernel.org> wrote:
> >
> > most of the stuff there can be re-used with ReST format,
> > but we need to add an empty TOC and remove the existing
> > entries, as the following conversion patches will be re-adding
> > them, as they're converted.  
> 
> I see a very little value in converting the files in the cpu-freq
> directory from .txt to .rst, which I have told you at least twice.
> 
> They are just old-style driver API documents for cpufreq, but moving
> them under driver-api/ as they are would not be a good idea IMO,
> because at least some of them are outdated (note that the admin-guide
> part of the cpufreq documentation, in the .rst format, is located
> under admin-guide/).
> 
> I haven't had the time to write a proper replacement for them yet and
> honestly I find it quite obnoxious to see these reoccurring attempts
> to blindly convert them to .rst without taking care of their contents
> and location.
> 
> I will take care of these files at one point as promised, but that's
> not going to happen today or tomorrow and please just leave them alone
> if that is not a big deal.

Sorry, I completely forgot that you asked to skip the old cpufreq docs.
My bad!

The thing is that I have now fully converted all docs to ReST (with a
handful exceptions for things that may not make sense to convert, like
configuration files that ends with .txt).

As a matter of helping those (like me) that are trying to finish this
huge conversion/reorganize task, I would very much prefer to keep those
files converted somewhere (or trashed, if their contents is now completely
garbage).

One of the things we discussed at linux-doc ML is to create a "staging"
area where we can place:

- things that aren't ready to be at the main documentation body yet;
- too obsolete docs that may require major work;
- things that we didn't find a good place to put yet.

From the last discussions, it seems we reach a consensus about creating that.

So, I should be preparing a separate patchset adding a Documentation/staging
dir. 

Would it be OK for you if I change the cpufreq patches on this series to
be moving those into a new Documentation/staging/cpufreq directory?

Regards,
Mauro

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-02-28  9:14     ` Mauro Carvalho Chehab
@ 2020-02-28  9:33       ` Rafael J. Wysocki
  0 siblings, 0 replies; 16+ messages in thread
From: Rafael J. Wysocki @ 2020-02-28  9:33 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Rafael J. Wysocki, Linux Doc Mailing List, Jonathan Corbet,
	Viresh Kumar, Linux PM

On Fri, Feb 28, 2020 at 10:14 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> Hi Rafael,
>
> Em Mon, 17 Feb 2020 21:06:20 +0100
> "Rafael J. Wysocki" <rafael@kernel.org> escreveu:
>
> > On Mon, Feb 17, 2020 at 5:20 PM Mauro Carvalho Chehab
> > <mchehab+huawei@kernel.org> wrote:
> > >
> > > most of the stuff there can be re-used with ReST format,
> > > but we need to add an empty TOC and remove the existing
> > > entries, as the following conversion patches will be re-adding
> > > them, as they're converted.
> >
> > I see a very little value in converting the files in the cpu-freq
> > directory from .txt to .rst, which I have told you at least twice.
> >
> > They are just old-style driver API documents for cpufreq, but moving
> > them under driver-api/ as they are would not be a good idea IMO,
> > because at least some of them are outdated (note that the admin-guide
> > part of the cpufreq documentation, in the .rst format, is located
> > under admin-guide/).
> >
> > I haven't had the time to write a proper replacement for them yet and
> > honestly I find it quite obnoxious to see these reoccurring attempts
> > to blindly convert them to .rst without taking care of their contents
> > and location.
> >
> > I will take care of these files at one point as promised, but that's
> > not going to happen today or tomorrow and please just leave them alone
> > if that is not a big deal.
>
> Sorry, I completely forgot that you asked to skip the old cpufreq docs.
> My bad!
>
> The thing is that I have now fully converted all docs to ReST (with a
> handful exceptions for things that may not make sense to convert, like
> configuration files that ends with .txt).

And I have this patch:

https://patchwork.kernel.org/patch/11411035/

so at least please drop the commits converting the three files affected by it.

> As a matter of helping those (like me) that are trying to finish this
> huge conversion/reorganize task, I would very much prefer to keep those
> files converted somewhere (or trashed, if their contents is now completely
> garbage).
>
> One of the things we discussed at linux-doc ML is to create a "staging"
> area where we can place:
>
> - things that aren't ready to be at the main documentation body yet;
> - too obsolete docs that may require major work;
> - things that we didn't find a good place to put yet.
>
> From the last discussions, it seems we reach a consensus about creating that.

So the other files in Documentation/cpu-freq/ can be converted to .rst
as far as I'm concerned (even though I still don't see much value in
doing that, just for the record).

They will be going away anyway in the future, regardless of the format
in which they are at that time. :-)

Cheers!

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt " Mauro Carvalho Chehab
  2020-02-17 20:06   ` Rafael J. Wysocki
@ 2020-03-02 21:19   ` Jonathan Corbet
  2020-03-02 22:16     ` Rafael J. Wysocki
  2020-03-03 14:01     ` Mauro Carvalho Chehab
  1 sibling, 2 replies; 16+ messages in thread
From: Jonathan Corbet @ 2020-03-02 21:19 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Rafael J. Wysocki, Viresh Kumar, linux-pm

On Mon, 17 Feb 2020 17:20:32 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> most of the stuff there can be re-used with ReST format,
> but we need to add an empty TOC and remove the existing
> entries, as the following conversion patches will be re-adding
> them, as they're converted.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Rafael, do you want to carry the cpu-freq changes from this set, or should
I just apply the whole thing over here?

Thanks,

jon

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-03-02 21:19   ` Jonathan Corbet
@ 2020-03-02 22:16     ` Rafael J. Wysocki
  2020-03-03 13:54       ` Mauro Carvalho Chehab
  2020-03-03 14:01     ` Mauro Carvalho Chehab
  1 sibling, 1 reply; 16+ messages in thread
From: Rafael J. Wysocki @ 2020-03-02 22:16 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Rafael J. Wysocki,
	Viresh Kumar, Linux PM

On Mon, Mar 2, 2020 at 10:19 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Mon, 17 Feb 2020 17:20:32 +0100
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>
> > most of the stuff there can be re-used with ReST format,
> > but we need to add an empty TOC and remove the existing
> > entries, as the following conversion patches will be re-adding
> > them, as they're converted.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>
> Rafael, do you want to carry the cpu-freq changes from this set, or should
> I just apply the whole thing over here?

I will take the ones that are applicable after rebasing on top of
https://patchwork.kernel.org/patch/11411035/

Cheers!

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-03-02 22:16     ` Rafael J. Wysocki
@ 2020-03-03 13:54       ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-03-03 13:54 UTC (permalink / raw)
  To: Rafael J. Wysocki
  Cc: Jonathan Corbet, Linux Doc Mailing List, Rafael J. Wysocki,
	Viresh Kumar, Linux PM

Em Mon, 2 Mar 2020 23:16:10 +0100
"Rafael J. Wysocki" <rafael@kernel.org> escreveu:

> On Mon, Mar 2, 2020 at 10:19 PM Jonathan Corbet <corbet@lwn.net> wrote:
> >
> > On Mon, 17 Feb 2020 17:20:32 +0100
> > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> >  
> > > most of the stuff there can be re-used with ReST format,
> > > but we need to add an empty TOC and remove the existing
> > > entries, as the following conversion patches will be re-adding
> > > them, as they're converted.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> >
> > Rafael, do you want to carry the cpu-freq changes from this set, or should
> > I just apply the whole thing over here?  
> 
> I will take the ones that are applicable after rebasing on top of
> https://patchwork.kernel.org/patch/11411035/

Just rebased on the top of it (plus next-20200303) and sent.

Btw, patch 1/5 of such series is just a small fix for the above. It
addresses a Kconfig.x86 pointer to a documentation file that were moved
by the above patch. 

Feel free to merge it with patch #11411035 if you want.

Regards,
Mauro

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST
  2020-03-02 21:19   ` Jonathan Corbet
  2020-03-02 22:16     ` Rafael J. Wysocki
@ 2020-03-03 14:01     ` Mauro Carvalho Chehab
  1 sibling, 0 replies; 16+ messages in thread
From: Mauro Carvalho Chehab @ 2020-03-03 14:01 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Linux Doc Mailing List, Rafael J. Wysocki, Viresh Kumar, linux-pm

Em Mon, 2 Mar 2020 14:19:16 -0700
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Mon, 17 Feb 2020 17:20:32 +0100
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 
> > most of the stuff there can be re-used with ReST format,
> > but we need to add an empty TOC and remove the existing
> > entries, as the following conversion patches will be re-adding
> > them, as they're converted.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> 
> Rafael, do you want to carry the cpu-freq changes from this set, or should
> I just apply the whole thing over here?

Hi Jon,

As Rafael should be applying the cpu-freq via his tree, I'm re-sending the
remaining patches on this series as:

	[PATCH v3 00/18] Manually convert  thermal, crypto and misc devices to ReST

Regards,
Mauro

^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2020-03-03 14:01 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt " Mauro Carvalho Chehab
2020-02-17 20:06   ` Rafael J. Wysocki
2020-02-28  9:14     ` Mauro Carvalho Chehab
2020-02-28  9:33       ` Rafael J. Wysocki
2020-03-02 21:19   ` Jonathan Corbet
2020-03-02 22:16     ` Rafael J. Wysocki
2020-03-03 13:54       ` Mauro Carvalho Chehab
2020-03-03 14:01     ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 16/24] docs: cpu-freq: convert core.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt " Mauro Carvalho Chehab

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).