diff mbox series

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

Message ID 20230213100800.28333-3-bagasdotme@gmail.com
State New
Headers
Series Documentation fixes for thermal/bleeding-edge |

Commit Message

Bagas Sanjaya Feb. 13, 2023, 10:08 a.m. UTC 
  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(-)

Comments

srinivas pandruvada Feb. 13, 2023, 10:17 a.m. UTC | #1 
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
Bagas Sanjaya Feb. 14, 2023, 2:16 a.m. UTC | #2 
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!
diff mbox series

Patch

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