2023-02-15 12:33:11

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections

kernel test robot reported htmldocs warning:

Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance in Documentation/admin-guide/pm/amd-pstate.rst

The documentation contains two sections with the same "User Space Interface
in ``sysfs``" title. The first one deals with per-policy sysfs and the
second one is about general attributes (currently only global attributes
are documented).

Disambiguate title text of both sections to fix the warning.

Link: https://lore.kernel.org/linux-doc/[email protected]/
Fixes: b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")
Reported-by: kernel test robot <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
index bca9a0ebee3ed8..6e5298b521b18b 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond
to the request from AMD P-States.


-User Space Interface in ``sysfs``
-==================================
+User Space Interface in ``sysfs`` - Per-policy control
+======================================================

``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to
control its functionality at the system level. They are located in the
@@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c
operating conditions allow.


-User Space Interface in ``sysfs``
-=================================
+User Space Interface in ``sysfs`` - General
+===========================================

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



2023-02-15 13:53:22

by Wyes Karny

[permalink] [raw]
Subject: Re: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections

On 15 Feb 19:32, Bagas Sanjaya wrote:
> kernel test robot reported htmldocs warning:
>
> Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance in Documentation/admin-guide/pm/amd-pstate.rst
>
> The documentation contains two sections with the same "User Space Interface
> in ``sysfs``" title. The first one deals with per-policy sysfs and the
> second one is about general attributes (currently only global attributes
> are documented).
>
> Disambiguate title text of both sections to fix the warning.
>
> Link: https://lore.kernel.org/linux-doc/[email protected]/
> Fixes: b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")
> Reported-by: kernel test robot <[email protected]>

Reviewed-by: Wyes Karny <[email protected]>

> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index bca9a0ebee3ed8..6e5298b521b18b 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond
> to the request from AMD P-States.
>
>
> -User Space Interface in ``sysfs``
> -==================================
> +User Space Interface in ``sysfs`` - Per-policy control
> +======================================================
>
> ``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to
> control its functionality at the system level. They are located in the
> @@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c
> operating conditions allow.
>
>
> -User Space Interface in ``sysfs``
> -=================================
> +User Space Interface in ``sysfs`` - General
> +===========================================
>
> Global Attributes
> -----------------
> --
> An old man doll... just what I always wanted! - Clara
>

Thanks,
Wyes

2023-02-15 14:21:11

by Huang Rui

[permalink] [raw]
Subject: Re: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections

On Wed, Feb 15, 2023 at 08:32:53PM +0800, Bagas Sanjaya wrote:
> kernel test robot reported htmldocs warning:
>
> Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance in Documentation/admin-guide/pm/amd-pstate.rst
>
> The documentation contains two sections with the same "User Space Interface
> in ``sysfs``" title. The first one deals with per-policy sysfs and the
> second one is about general attributes (currently only global attributes
> are documented).
>
> Disambiguate title text of both sections to fix the warning.
>
> Link: https://lore.kernel.org/linux-doc/[email protected]/
> Fixes: b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>

Acked-by: Huang Rui <[email protected]>

> ---
> Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index bca9a0ebee3ed8..6e5298b521b18b 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond
> to the request from AMD P-States.
>
>
> -User Space Interface in ``sysfs``
> -==================================
> +User Space Interface in ``sysfs`` - Per-policy control
> +======================================================
>
> ``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to
> control its functionality at the system level. They are located in the
> @@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c
> operating conditions allow.
>
>
> -User Space Interface in ``sysfs``
> -=================================
> +User Space Interface in ``sysfs`` - General
> +===========================================
>
> Global Attributes
> -----------------
> --
> An old man doll... just what I always wanted! - Clara
>

2023-02-15 14:59:51

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections

On Wed, Feb 15, 2023 at 3:21 PM Huang Rui <[email protected]> wrote:
>
> On Wed, Feb 15, 2023 at 08:32:53PM +0800, Bagas Sanjaya wrote:
> > kernel test robot reported htmldocs warning:
> >
> > Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance in Documentation/admin-guide/pm/amd-pstate.rst
> >
> > The documentation contains two sections with the same "User Space Interface
> > in ``sysfs``" title. The first one deals with per-policy sysfs and the
> > second one is about general attributes (currently only global attributes
> > are documented).
> >
> > Disambiguate title text of both sections to fix the warning.
> >
> > Link: https://lore.kernel.org/linux-doc/[email protected]/
> > Fixes: b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")
> > Reported-by: kernel test robot <[email protected]>
> > Signed-off-by: Bagas Sanjaya <[email protected]>
>
> Acked-by: Huang Rui <[email protected]>

Applied as 6.3 material, thanks!