Skip to content

Commit 3fa3b20

Browse files
jayaddisonJonathan Corbet
authored and
Jonathan Corbet
committed
docs: Disambiguate a pair of rST labels
According to the reStructuredText documentation, internal hyperlink targets[1] are intended to resolve within the current document. Sphinx has a bug that causes internal hyperlinks declared with duplicate names to resolve nondeterministically, producing incorrect documentation. Sphinx does not yet emit a warning when these duplicate target names are declared. To improve the reproducibility and correctness of the HTML documentation, disambiguate two labels both previously titled "submit_improvements". [1] - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets Link: sphinx-doc/sphinx#13383 Signed-off-by: James Addison <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent fb42d8d commit 3fa3b20

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Documentation/admin-guide/quickly-build-trimmed-linux.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ again.
347347

348348
[:ref:`details<uninstall>`]
349349

350-
.. _submit_improvements:
350+
.. _submit_improvements_qbtl:
351351

352352
Did you run into trouble following any of the above steps that is not cleared up
353353
by the reference section below? Or do you have ideas how to improve the text?
@@ -1070,7 +1070,7 @@ complicated, and harder to follow.
10701070

10711071
That being said: this of course is a balancing act. Hence, if you think an
10721072
additional use-case is worth describing, suggest it to the maintainers of this
1073-
document, as :ref:`described above <submit_improvements>`.
1073+
document, as :ref:`described above <submit_improvements_qbtl>`.
10741074

10751075

10761076
..

Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ culprit might be known already. For further details on what actually qualifies
267267
as a regression check out Documentation/admin-guide/reporting-regressions.rst.
268268

269269
If you run into any problems while following this guide or have ideas how to
270-
improve it, :ref:`please let the kernel developers know <submit_improvements>`.
270+
improve it, :ref:`please let the kernel developers know <submit_improvements_vbbr>`.
271271

272272
.. _introprep_bissbs:
273273

@@ -1055,7 +1055,7 @@ follow these instructions.
10551055

10561056
[:ref:`details <introoptional_bisref>`]
10571057

1058-
.. _submit_improvements:
1058+
.. _submit_improvements_vbbr:
10591059

10601060
Conclusion
10611061
----------

0 commit comments

Comments
 (0)