[PATCH 0/3] Documentation fixes for thermal/bleeding-edge

[PATCH 0/3] Documentation fixes for thermal/bleeding-edge

[Bagas Sanjaya]

Here are documentation fixes for thermal/bleeding-edge tree. The
first two patches are fixes to recently reported kernel test robot
reports whereas the third patch is cosmetical (formatting).

Bagas Sanjaya (3):
  Documentation: admin-guide: Add toctree entry for thermal docs
  Documentation: powerclamp: Escape wildcard in cpumask description
  Documentation: powerclamp: Fix numbered lists formatting

 Documentation/admin-guide/index.rst               |  2 +-
 Documentation/admin-guide/thermal/index.rst       |  8 ++++++++
 .../admin-guide/thermal/intel_powerclamp.rst      | 15 +++++++++------
 3 files changed, 18 insertions(+), 7 deletions(-)
 create mode 100644 Documentation/admin-guide/thermal/index.rst


base-commit: 1c7337f9eef60b8ce8a4b8c96d197e230d60b6b2
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs

[Bagas Sanjaya]

kernel test robot reported htmldocs warnings:

Documentation/admin-guide/index.rst:62: WARNING: toctree contains reference to nonexisting document 'admin-guide/thermal'
Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING: document isn't included in any toctree

Add toctree entry for thermal/ docs to fix these warnings.

Link: https://lore.kernel.org/linux-doc/202302121759.MmJgDTxc-lkp@intel.com/
Fixes: 707bf8e1dfd51d ("Documentation: admin-guide: Move intel_powerclamp documentation")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/index.rst         | 2 +-
 Documentation/admin-guide/thermal/index.rst | 8 ++++++++
 2 files changed, 9 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/admin-guide/thermal/index.rst

diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index c872a8a1ddfa28..0571938ecdc868 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -116,7 +116,7 @@ configure specific aspects of kernel behavior to your liking.
    svga
    syscall-user-dispatch
    sysrq
-   thermal
+   thermal/index
    thunderbolt
    ufs
    unicode
diff --git a/Documentation/admin-guide/thermal/index.rst b/Documentation/admin-guide/thermal/index.rst
new file mode 100644
index 00000000000000..193b7b01a87d7e
--- /dev/null
+++ b/Documentation/admin-guide/thermal/index.rst
@@ -0,0 +1,8 @@
+=================
+Thermal Subsystem
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   intel_powerclamp
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs

[srinivas pandruvada]

Hi Sanjaya,

On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
> kernel test robot reported htmldocs warnings:
> 
> Documentation/admin-guide/index.rst:62: WARNING: toctree contains
> reference to nonexisting document 'admin-guide/thermal'
> Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING:
> document isn't included in any toctree
> 
> Add toctree entry for thermal/ docs to fix these warnings.
> 
I submitted a patch 
	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings

Thanks,
Srinivas

> Link:
> https://lore.kernel.org/linux-doc/202302121759.MmJgDTxc-lkp@intel.com/
> Fixes: 707bf8e1dfd51d ("Documentation: admin-guide: Move
> intel_powerclamp documentation")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/admin-guide/index.rst         | 2 +-
>  Documentation/admin-guide/thermal/index.rst | 8 ++++++++
>  2 files changed, 9 insertions(+), 1 deletion(-)
>  create mode 100644 Documentation/admin-guide/thermal/index.rst
> 
> diff --git a/Documentation/admin-guide/index.rst
> b/Documentation/admin-guide/index.rst
> index c872a8a1ddfa28..0571938ecdc868 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -116,7 +116,7 @@ configure specific aspects of kernel behavior to
> your liking.
>     svga
>     syscall-user-dispatch
>     sysrq
> -   thermal
> +   thermal/index
>     thunderbolt
>     ufs
>     unicode
> diff --git a/Documentation/admin-guide/thermal/index.rst
> b/Documentation/admin-guide/thermal/index.rst
> new file mode 100644
> index 00000000000000..193b7b01a87d7e
> --- /dev/null
> +++ b/Documentation/admin-guide/thermal/index.rst
> @@ -0,0 +1,8 @@
> +=================
> +Thermal Subsystem
> +=================
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   intel_powerclamp

Re: [PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs

[Bagas Sanjaya]

On 2/13/23 17:15, srinivas pandruvada wrote:
> Hi Sanjaya,
> 
> On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
>> kernel test robot reported htmldocs warnings:
>>
>> Documentation/admin-guide/index.rst:62: WARNING: toctree contains
>> reference to nonexisting document 'admin-guide/thermal'
>> Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING:
>> document isn't included in any toctree
>>
>> Add toctree entry for thermal/ docs to fix these warnings.
>>
> I submitted a patch 
> 	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
> warnings
> 
> Thanks,
> Srinivas
> 

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description

[Bagas Sanjaya]

kernel test robot reported htmldocs warning:

Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING: Inline emphasis start-string without end-string.

The mistaken asterisk in /proc/irq/*/smp_affinity is rendered as hyperlink
as the result.

Escape the asterisk to fix above warning.

Link: https://lore.kernel.org/linux-doc/202302122247.N4S791c4-lkp@intel.com/
Fixes: ebf51971021881 ("thermal: intel: powerclamp: Add two module parameters")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/thermal/intel_powerclamp.rst b/Documentation/admin-guide/thermal/intel_powerclamp.rst
index 2d9d2d739f0256..f919fbe1cdd942 100644
--- a/Documentation/admin-guide/thermal/intel_powerclamp.rst
+++ b/Documentation/admin-guide/thermal/intel_powerclamp.rst
@@ -326,7 +326,7 @@ Module Parameters
 
 ``cpumask`` (RW)
 	A bit mask of CPUs to inject idle. The format of the bitmask is same as
-	used in other subsystems like in /proc/irq/*/smp_affinity. The mask is
+	used in other subsystems like in /proc/irq/\*/smp_affinity. The mask is
 	comma separated 32 bit groups. Each CPU is one bit. For example for a 256
 	CPU system the full mask is:
 	ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description

[srinivas pandruvada]

Hi Sanjaya,

On Mon, 2023-02-13 at 17:08 +0700, Bagas Sanjaya wrote:
> kernel test robot reported htmldocs warning:
> 
> Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING:
> Inline emphasis start-string without end-string.
> 
> The mistaken asterisk in /proc/irq/*/smp_affinity is rendered as
> hyperlink
> as the result.
> 
I submitted a patch 
	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings.

Thanks,
Srinivas

> Escape the asterisk to fix above warning.
> 
> Link:
> https://lore.kernel.org/linux-doc/202302122247.N4S791c4-lkp@intel.com/
> Fixes: ebf51971021881 ("thermal: intel: powerclamp: Add two module
> parameters")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/thermal/intel_powerclamp.rst
> b/Documentation/admin-guide/thermal/intel_powerclamp.rst
> index 2d9d2d739f0256..f919fbe1cdd942 100644
> --- a/Documentation/admin-guide/thermal/intel_powerclamp.rst
> +++ b/Documentation/admin-guide/thermal/intel_powerclamp.rst
> @@ -326,7 +326,7 @@ Module Parameters
>  
>  ``cpumask`` (RW)
>         A bit mask of CPUs to inject idle. The format of the bitmask
> is same as
> -       used in other subsystems like in /proc/irq/*/smp_affinity.
> The mask is
> +       used in other subsystems like in /proc/irq/\*/smp_affinity.
> The mask is
>         comma separated 32 bit groups. Each CPU is one bit. For
> example for a 256
>         CPU system the full mask is:
>         ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,fffffff
> f,ffffffff

Re: [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description

[Bagas Sanjaya]

On 2/13/23 17:17, srinivas pandruvada wrote:
> Hi Sanjaya,
> 
> On Mon, 2023-02-13 at 17:08 +0700, Bagas Sanjaya wrote:
>> kernel test robot reported htmldocs warning:
>>
>> Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING:
>> Inline emphasis start-string without end-string.
>>
>> The mistaken asterisk in /proc/irq/*/smp_affinity is rendered as
>> hyperlink
>> as the result.
>>
> I submitted a patch 
> 	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
> warnings.
> 
> Thanks,
> Srinivas
> 

OK, thanks for your parallel!

-- 
An old man doll... just what I always wanted! - Clara

[PATCH 3/3] Documentation: powerclamp: Fix numbered lists formatting

[Bagas Sanjaya]

Texts in numbered lists are rendered as continous paragraph when there
should have been breaks between first line text in the beginning of list
item and the description. Fix this by adding appropriate line breaks and
indent the rest of lines to match the first line of numbered list item.

Fixes: d6d71ee4a14ae6 ("PM: Introduce Intel PowerClamp Driver")
Fixes: 6bbe6f5732faea ("docs: thermal: convert to ReST")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../admin-guide/thermal/intel_powerclamp.rst        | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/admin-guide/thermal/intel_powerclamp.rst b/Documentation/admin-guide/thermal/intel_powerclamp.rst
index f919fbe1cdd942..3ce96043af1797 100644
--- a/Documentation/admin-guide/thermal/intel_powerclamp.rst
+++ b/Documentation/admin-guide/thermal/intel_powerclamp.rst
@@ -155,13 +155,15 @@ b) determine the amount of compensation needed at each target ratio
 Compensation to each target ratio consists of two parts:
 
 	a) steady state error compensation
-	This is to offset the error occurring when the system can
-	enter idle without extra wakeups (such as external interrupts).
+
+	   This is to offset the error occurring when the system can
+	   enter idle without extra wakeups (such as external interrupts).
 
 	b) dynamic error compensation
-	When an excessive amount of wakeups occurs during idle, an
-	additional idle ratio can be added to quiet interrupts, by
-	slowing down CPU activities.
+
+	   When an excessive amount of wakeups occurs during idle, an
+	   additional idle ratio can be added to quiet interrupts, by
+	   slowing down CPU activities.
 
 A debugfs file is provided for the user to examine compensation
 progress and results, such as on a Westmere system::
@@ -283,6 +285,7 @@ cur_state returns value -1 instead of 0 which is to avoid confusing
 100% busy state with the disabled state.
 
 Example usage:
+
 - To inject 25% idle time::
 
 	$ sudo sh -c "echo 25 > /sys/class/thermal/cooling_device80/cur_state
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] Documentation fixes for thermal/bleeding-edge

[srinivas pandruvada]

On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
> Here are documentation fixes for thermal/bleeding-edge tree. The
> first two patches are fixes to recently reported kernel test robot
> reports whereas the third patch is cosmetical (formatting).
> 
I am fine picking up this patchset over mine, as this series has  one
additional fix.

	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings

Thanks,
Srinivas


> Bagas Sanjaya (3):
>   Documentation: admin-guide: Add toctree entry for thermal docs
>   Documentation: powerclamp: Escape wildcard in cpumask description
>   Documentation: powerclamp: Fix numbered lists formatting
> 
>  Documentation/admin-guide/index.rst               |  2 +-
>  Documentation/admin-guide/thermal/index.rst       |  8 ++++++++
>  .../admin-guide/thermal/intel_powerclamp.rst      | 15 +++++++++----
> --
>  3 files changed, 18 insertions(+), 7 deletions(-)
>  create mode 100644 Documentation/admin-guide/thermal/index.rst
> 
> 
> base-commit: 1c7337f9eef60b8ce8a4b8c96d197e230d60b6b2

Re: [PATCH 0/3] Documentation fixes for thermal/bleeding-edge

[Rafael J. Wysocki]

On Mon, Feb 13, 2023 at 11:18 AM srinivas pandruvada
<srinivas.pandruvada@linux.intel.com> wrote:
>
> On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
> > Here are documentation fixes for thermal/bleeding-edge tree. The
> > first two patches are fixes to recently reported kernel test robot
> > reports whereas the third patch is cosmetical (formatting).
> >
> I am fine picking up this patchset over mine, as this series has  one
> additional fix.
>
>         [thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
> warnings

So applied, thanks!