docs: Disambiguate a pair of rST labels
authorJames Addison <jay@jp-hosting.net>
Mon, 7 Apr 2025 19:51:20 +0000 (21:51 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 14 Apr 2025 16:22:46 +0000 (10:22 -0600)
commit3fa3b20ba15cddc4462e64a79d779ad3b2d0d4e1
tree8dd1c0c5b841aac3f3fd86bbe7c7a8c3c4e7994e
parentfb42d8dcbc3f01782b4df4ef2b69ec5a902d992e
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: https://github.com/sphinx-doc/sphinx/issues/13383
Signed-off-by: James Addison <jay@jp-hosting.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250407195120.331103-2-jvanderwaa@redhat.com
Documentation/admin-guide/quickly-build-trimmed-linux.rst
Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst