Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: intel_pstate: fix duplicate hyperlink target errors

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".

These errors occurred because the sections "Active Mode",
"Active Mode With HWP", "Passive Mode", and "Global Attributes"
did not define explicit hyperlink labels. As a result, Sphinx
auto-generated duplicate anchors when the same titles appeared
multiple times within the document.

Because of this, the generated HTML documentation contained
broken references such as:

`active mode <Active Mode_>`_
`passive mode <Passive Mode_>`_
`global attributes <Global Attributes_>`_

This patch adds explicit hyperlink labels for the affected sections,
ensuring all references are unique and correctly resolved.

After applying this patch, `make htmldocs` completes without
any warnings, and all hyperlinks in intel_pstate.html render properly.

Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
[ rjw: Subject adjustment ]
Link: https://patch.msgid.link/20251029134737.42229-1-swarajgaikwad1925@gmail.com
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

authored by

Swaraj Gaikwad and committed by
Rafael J. Wysocki
cb908f8b ace04717

+8
+8
Documentation/admin-guide/pm/intel_pstate.rst
··· 62 62 depends on what kernel command line options are used and on the capabilities of 63 63 the processor. 64 64 65 + .. _Active Mode: 66 + 65 67 Active Mode 66 68 ----------- 67 69 ··· 95 93 :c:macro:`CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE` kernel configuration option. 96 94 Namely, if that option is set, the ``performance`` algorithm will be used by 97 95 default, and the other one will be used by default if it is not set. 96 + 97 + .. _Active Mode With HWP: 98 98 99 99 Active Mode With HWP 100 100 ~~~~~~~~~~~~~~~~~~~~ ··· 195 191 This is the default P-state selection algorithm if the 196 192 :c:macro:`CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE` kernel configuration option 197 193 is not set. 194 + 195 + .. _Passive Mode: 198 196 199 197 Passive Mode 200 198 ------------ ··· 437 431 438 432 User Space Interface in ``sysfs`` 439 433 ================================= 434 + 435 + .. _Global Attributes: 440 436 441 437 Global Attributes 442 438 -----------------