Re: [PATCH 01/21] docs: hwmon: k10temp: convert to ReST format

From: Guenter Roeck
Date: Wed Apr 10 2019 - 14:31:08 EST


On Wed, Apr 10, 2019 at 08:11:51AM -0300, Mauro Carvalho Chehab wrote:
> Convert k10temp to ReST format, in order to allow it to
> be parsed by Sphinx.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>

The first Signed-off-by: is bad. This affects all patches in the series.

Guenter

> ---
> Documentation/hwmon/k10temp | 37 ++++++++++++++++++++++++++++++++++++-
> 1 file changed, 36 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/hwmon/k10temp b/Documentation/hwmon/k10temp
> index 254d2f55345a..12a86ba17de9 100644
> --- a/Documentation/hwmon/k10temp
> +++ b/Documentation/hwmon/k10temp
> @@ -2,42 +2,77 @@ Kernel driver k10temp
> =====================
>
> Supported chips:
> +
> * AMD Family 10h processors:
> +
> Socket F: Quad-Core/Six-Core/Embedded Opteron (but see below)
> +
> Socket AM2+: Quad-Core Opteron, Phenom (II) X3/X4, Athlon X2 (but see below)
> +
> Socket AM3: Quad-Core Opteron, Athlon/Phenom II X2/X3/X4, Sempron II
> +
> Socket S1G3: Athlon II, Sempron, Turion II
> +
> * AMD Family 11h processors:
> +
> Socket S1G2: Athlon (X2), Sempron (X2), Turion X2 (Ultra)
> +
> * AMD Family 12h processors: "Llano" (E2/A4/A6/A8-Series)
> +
> * AMD Family 14h processors: "Brazos" (C/E/G/Z-Series)
> +
> * AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity", "Kaveri", "Carrizo"
> +
> * AMD Family 16h processors: "Kabini", "Mullins"
>
> Prefix: 'k10temp'
> +
> Addresses scanned: PCI space
> +
> Datasheets:
> +
> BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/31116.pdf
> +
> BIOS and Kernel Developer's Guide (BKDG) for AMD Family 11h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/41256.pdf
> +
> BIOS and Kernel Developer's Guide (BKDG) for AMD Family 12h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/41131.pdf
> +
> BIOS and Kernel Developer's Guide (BKDG) for AMD Family 14h Models 00h-0Fh Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/43170.pdf
> +
> Revision Guide for AMD Family 10h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/41322.pdf
> +
> Revision Guide for AMD Family 11h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/41788.pdf
> +
> Revision Guide for AMD Family 12h Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/44739.pdf
> +
> Revision Guide for AMD Family 14h Models 00h-0Fh Processors:
> +
> http://support.amd.com/us/Processor_TechDocs/47534.pdf
> +
> AMD Family 11h Processor Power and Thermal Data Sheet for Notebooks:
> +
> http://support.amd.com/us/Processor_TechDocs/43373.pdf
> +
> AMD Family 10h Server and Workstation Processor Power and Thermal Data Sheet:
> +
> http://support.amd.com/us/Processor_TechDocs/43374.pdf
> +
> AMD Family 10h Desktop Processor Power and Thermal Data Sheet:
> +
> http://support.amd.com/us/Processor_TechDocs/43375.pdf
>
> Author: Clemens Ladisch <clemens@xxxxxxxxxx>
> @@ -60,7 +95,7 @@ are using an AM3 processor on an AM2+ mainboard, you can safely use the
>
> There is one temperature measurement value, available as temp1_input in
> sysfs. It is measured in degrees Celsius with a resolution of 1/8th degree.
> -Please note that it is defined as a relative value; to quote the AMD manual:
> +Please note that it is defined as a relative value; to quote the AMD manual::
>
> Tctl is the processor temperature control value, used by the platform to
> control cooling systems. Tctl is a non-physical temperature on an