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

From: srinivas pandruvada
Date: Mon Feb 13 2023 - 05:17:32 EST


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@xxxxxxxxx/
> Fixes: ebf51971021881 ("thermal: intel: powerclamp: Add two module
> parameters")
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> ---
>  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