linux-kernel - Re: [PATCH] Documentation: pm: fix duplicate hyperlink target errors

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <81b03d82-6dc7-4af1-bca1-3632e1a0b4c0@infradead.org>
Date: Wed, 29 Oct 2025 10:01:19 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Swaraj Gaikwad <swarajgaikwad1925@...il.com>,
 "Rafael J. Wysocki" <rafael@...nel.org>,
 Viresh Kumar <viresh.kumar@...aro.org>, Jonathan Corbet <corbet@....net>,
 "open list:CPU FREQUENCY SCALING FRAMEWORK" <linux-pm@...r.kernel.org>,
 "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
 open list <linux-kernel@...r.kernel.org>
Cc: skhan@...uxfoundation.org, david.hunter.linux@...il.com
Subject: Re: [PATCH] Documentation: pm: fix duplicate hyperlink target errors



On 10/29/25 3:55 AM, Bagas Sanjaya wrote:
> On Wed, Oct 29, 2025 at 01:47:37PM +0000, Swaraj Gaikwad wrote:
>> Fix reST warnings in
>> Documentation/admin-guide/pm/intel_pstate.rst caused by missing explicit
>> hyperlink labels for section titles.
>>
>> Before this change, the following errors were printed during
>> `make htmldocs`:
>>
>>   Documentation/admin-guide/pm/intel_pstate.rst:401:
>>     ERROR: Indirect hyperlink target (id="id6") refers to target
>>     "passive mode", which is a duplicate, and cannot be used as a
>>     unique reference.
>>   Documentation/admin-guide/pm/intel_pstate.rst:517:
>>     ERROR: Indirect hyperlink target (id="id9") refers to target
>>     "active mode", which is a duplicate, and cannot be used as a
>>     unique reference.
>>   Documentation/admin-guide/pm/intel_pstate.rst:611:
>>     ERROR: Indirect hyperlink target (id="id15") refers to target
>>     "global attributes", which is a duplicate, and cannot be used as
>>     a unique reference.
>>   ERROR: Duplicate target name, cannot be used as a unique reference:
>>   "passive mode", "active mode", "global attributes".
> 
> Hmm... I don't see these warnings when I build htmldocs by:
> 
>   $ make SPHINXOPTS='-j 1' htmldocs
> 
> My environment uses docutils 0.21.2 and Sphinx 8.2.3, though. What are yours?


I do see the warnings and this patch fixes them in my testing.

Acked-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

docutils-3.13 (Docutils 0.22.2, Python 3.13.9, on linux)
sphinx-build 8.2.3

>> diff --git a/Documentation/admin-guide/pm/intel_pstate.rst b/Documentation/admin-guide/pm/intel_pstate.rst
>> index 26e702c7016e..9cdd9dad6516 100644
>> --- a/Documentation/admin-guide/pm/intel_pstate.rst
>> +++ b/Documentation/admin-guide/pm/intel_pstate.rst
>> @@ -62,6 +62,8 @@ a certain performance scaling algorithm.  Which of them will be in effect
>>  depends on what kernel command line options are used and on the capabilities of
>>  the processor.
>>
>> +.. _Active Mode:
>> +
>>  Active Mode
>>  -----------
>>
>> @@ -94,6 +96,8 @@ Which of the P-state selection algorithms is used by default depends on the
>>  Namely, if that option is set, the ``performance`` algorithm will be used by
>>  default, and the other one will be used by default if it is not set.
>>
>> +.. _Active Mode With HWP:
>> +
>>  Active Mode With HWP
>>  ~~~~~~~~~~~~~~~~~~~~
>>
>> @@ -192,6 +196,8 @@ This is the default P-state selection algorithm if the
>>  :c:macro:`CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE` kernel configuration option
>>  is not set.
>>
>> +.. _Passive Mode:
>> +
>>  Passive Mode
>>  ------------
>>
>> @@ -432,6 +438,8 @@ the ``energy_model`` directory in ``debugfs`` (typlically mounted on
>>  User Space Interface in ``sysfs``
>>  =================================
>>
>> +.. _Global Attributes:
>> +
>>  Global Attributes
>>  -----------------
>>
>>
> 
> The diff LGTM, nevertheless.
> 
> Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>
> 
> Thanks.
> 



-- 
~Randy