mbox series

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

Message ID 20230213100800.28333-1-bagasdotme@gmail.com
Headers show
Series Documentation fixes for thermal/bleeding-edge | expand

Message

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

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
Rafael J. Wysocki Feb. 13, 2023, 3:34 p.m. UTC | #2
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!
Bagas Sanjaya Feb. 14, 2023, 2:16 a.m. UTC | #3
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!