[v1] Documentation/admin-guide/pm/amd-pstate.rst: fix the warning: Title underline too short.

Message ID 20240212034015.120697-1-marilene.agarcia@gmail.com
State New
Headers
Series [v1] Documentation/admin-guide/pm/amd-pstate.rst: fix the warning: Title underline too short. |

Commit Message

MarileneGarcia Feb. 12, 2024, 3:40 a.m. UTC
  There was the following warning when the documentation was generated:

Documentation/admin-guide/pm/amd-pstate.rst:384: WARNING: Title underline too short.

``amd-pstate`` Preferred Core Switch
=================================

Signed-off-by: MarileneGarcia <marilene.agarcia@gmail.com>
---
Change:
Increasing title underline to solve the warning
Thank you.

 Documentation/admin-guide/pm/amd-pstate.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Randy Dunlap Feb. 12, 2024, 4:06 a.m. UTC | #1
On 2/11/24 19:40, MarileneGarcia wrote:
> There was the following warning when the documentation was generated:
> 
> Documentation/admin-guide/pm/amd-pstate.rst:384: WARNING: Title underline too short.
> 
> ``amd-pstate`` Preferred Core Switch
> =================================
> 
> Signed-off-by: MarileneGarcia <marilene.agarcia@gmail.com>
> ---
> Change:
> Increasing title underline to solve the warning
> Thank you.
> 
>  Documentation/admin-guide/pm/amd-pstate.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index 0a3aa6b8ffd5..322488a0b2c9 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -381,7 +381,7 @@ driver receives a message with the highest performance change, it will
>  update the core ranking and set the cpu's priority.
>  
>  ``amd-pstate`` Preferred Core Switch
> -=================================
> +====================================
>  Kernel Parameters
>  -----------------
>  

Hi,
This patch:
https://lore.kernel.org/all/20240205060305.3594942-1-li.meng@amd.com/

has been applied to the docs git tree but apparently has not found its
way to linux-next yet.

Thanks.
  

Patch

diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
index 0a3aa6b8ffd5..322488a0b2c9 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -381,7 +381,7 @@  driver receives a message with the highest performance change, it will
 update the core ranking and set the cpu's priority.
 
 ``amd-pstate`` Preferred Core Switch
-=================================
+====================================
 Kernel Parameters
 -----------------