Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output

[Gautham R Shenoy <ego@xxxxxxxxxxxxxxxxxx>]

On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> 
> Some files over there won't parse well by Sphinx.
> 

[..snip..]



> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu 
> b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index b555df825447..274c337ec6a9 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -151,23 +151,28 @@ Description:
>               The processor idle states which are available for use have the
>               following attributes:
> 
> -             name: (RO) Name of the idle state (string).
> +             ======== ==== =================================================
> +             name:    (RO) Name of the idle state (string).
> 
>               latency: (RO) The latency to exit out of this idle state (in
> -             microseconds).
> +                           microseconds).
> 
> -             power: (RO) The power consumed while in this idle state (in
> -             milliwatts).
> +             power:   (RO) The power consumed while in this idle state (in
> +                           milliwatts).
> 
> -             time: (RO) The total time spent in this idle state (in 
> microseconds).
> +             time:    (RO) The total time spent in this idle state
> +                           (in microseconds).
> 
> -             usage: (RO) Number of times this state was entered (a count).
> +             usage:   (RO) Number of times this state was entered (a count).
> 
> -             above: (RO) Number of times this state was entered, but the
> -                    observed CPU idle duration was too short for it (a 
> count).
> +             above:   (RO) Number of times this state was entered, but the
> +                           observed CPU idle duration was too short for it
> +                           (a count).
> 
> -             below: (RO) Number of times this state was entered, but the
> -                    observed CPU idle duration was too long for it (a count).
> +             below:   (RO) Number of times this state was entered, but the
> +                           observed CPU idle duration was too long for it
> +                           (a count).
> +             ======== ==== =================================================
> 
>  What:                /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc
>  Date:                February 2008
> @@ -290,6 +295,7 @@ Description:      Processor frequency boosting control
>               This switch controls the boost setting for the whole system.
>               Boosting allows the CPU and the firmware to run at a frequency
>               beyound it's nominal limit.
> +
>               More details can be found in
>               Documentation/admin-guide/pm/cpufreq.rst
> 

The changes to cpuidle states look good to me.


[..snip..]

> @@ -414,30 +434,30 @@ Description:    POWERNV CPUFreq driver's frequency 
> throttle stats directory and
>               throttle attributes exported in the 'throttle_stats' directory:
> 
>               - turbo_stat : This file gives the total number of times the max
> -             frequency is throttled to lower frequency in turbo (at and above
> -             nominal frequency) range of frequencies.
> +               frequency is throttled to lower frequency in turbo (at and 
> above
> +               nominal frequency) range of frequencies.
> 
>               - sub_turbo_stat : This file gives the total number of times the
> -             max frequency is throttled to lower frequency in sub-turbo(below
> -             nominal frequency) range of frequencies.
> +               max frequency is throttled to lower frequency in 
> sub-turbo(below
> +               nominal frequency) range of frequencies.
> 
>               - unthrottle : This file gives the total number of times the max
> -             frequency is unthrottled after being throttled.
> +               frequency is unthrottled after being throttled.
> 
>               - powercap : This file gives the total number of times the max
> -             frequency is throttled due to 'Power Capping'.
> +               frequency is throttled due to 'Power Capping'.
> 
>               - overtemp : This file gives the total number of times the max
> -             frequency is throttled due to 'CPU Over Temperature'.
> +               frequency is throttled due to 'CPU Over Temperature'.
> 
>               - supply_fault : This file gives the total number of times the
> -             max frequency is throttled due to 'Power Supply Failure'.
> +               max frequency is throttled due to 'Power Supply Failure'.
> 
>               - overcurrent : This file gives the total number of times the
> -             max frequency is throttled due to 'Overcurrent'.
> +               max frequency is throttled due to 'Overcurrent'.
> 
>               - occ_reset : This file gives the total number of times the max
> -             frequency is throttled due to 'OCC Reset'.
> +               frequency is throttled due to 'OCC Reset'.
> 
>               The sysfs attributes representing different throttle reasons 
> like
>               powercap, overtemp, supply_fault, overcurrent and occ_reset map 
> to


This hunk for the powernv cpufreq driver looks good to me.
For these two hunks,

Reviewed-by: Gautham R. Shenoy <ego@xxxxxxxxxxxxxxxxxx>