]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs: Don't define duplicate label in qemu-block-drivers.rst.inc
authorPeter Maydell <peter.maydell@linaro.org>
Thu, 1 May 2025 09:31:26 +0000 (10:31 +0100)
committerPeter Maydell <peter.maydell@linaro.org>
Tue, 6 May 2025 14:02:34 +0000 (15:02 +0100)
commit82707dd4f07613eed8d639956a43bddffca5cd5c
tree31a8542cc847e040a17a60eb7fa39bcccf94bfb3
parent8ed7c0b6488a7f20318d6ba414f1cbcd0ed92afe
docs: Don't define duplicate label in qemu-block-drivers.rst.inc

Sphinx requires that labels within documents are unique across the
whole manual.  This is because the "create a hyperlink" directive
specifies only the name of the label, not a filename+label.  Some
Sphinx versions will warn about duplicate labels, but even if there
is no warning there is still an ambiguity and no guarantee that the
hyperlink will be created to the right target.

For QEMU this is awkward, because we have various .rst.inc fragments
which we include into multiple .rst files.  If you define a label in
the .rst.inc file then it will be a duplicate label.  We have mostly
worked around this by not putting labels into those .rst.inc files,
or by adding "insert a label" functionality into the hxtool extension
(see commit 1eeb432a953b0 "doc/sphinx/hxtool.py: add optional label
argument to SRST directive").

Unfortunately in commit 7f6314427e78 ("docs/devel: add a codebase
section") we accidentally added a duplicate label, because not all
Sphinx versions warn about the mistake.

In this case the link was only from the developer docs codebase
summary, so as the simplest fix for the stable branch, we drop
the link entirely.

Cc: qemu-stable@nongnu.org
Fixes: 1eeb432a953b0 "doc/sphinx/hxtool.py: add optional label argument to SRST directive"
Reported-by: Dario Faggioli <dfaggioli@suse.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Message-id: 20250501093126.716667-1-peter.maydell@linaro.org
docs/devel/codebase.rst
docs/system/qemu-block-drivers.rst.inc