[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Stable-10.0.1 15/23] docs: Don't define duplicate label in qemu-block-d
From: |
Michael Tokarev |
Subject: |
[Stable-10.0.1 15/23] docs: Don't define duplicate label in qemu-block-drivers.rst.inc |
Date: |
Wed, 14 May 2025 22:00:27 +0300 |
From: Peter Maydell <peter.maydell@linaro.org>
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
(cherry picked from commit 82707dd4f07613eed8d639956a43bddffca5cd5c)
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
diff --git a/docs/devel/codebase.rst b/docs/devel/codebase.rst
index ef98578296..085da10a22 100644
--- a/docs/devel/codebase.rst
+++ b/docs/devel/codebase.rst
@@ -116,7 +116,7 @@ yet, so sometimes the source code is all you have.
* `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:
`Monitor <QEMU monitor>` implementation (HMP & QMP).
* `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:
- QEMU `NBD (Network Block Device) <nbd>` server.
+ QEMU NBD (Network Block Device) server.
* `net <https://gitlab.com/qemu-project/qemu/-/tree/master/net>`_:
Network (host) support.
* `pc-bios <https://gitlab.com/qemu-project/qemu/-/tree/master/pc-bios>`_:
diff --git a/docs/system/qemu-block-drivers.rst.inc
b/docs/system/qemu-block-drivers.rst.inc
index cfe1acb78a..384e95ba76 100644
--- a/docs/system/qemu-block-drivers.rst.inc
+++ b/docs/system/qemu-block-drivers.rst.inc
@@ -500,8 +500,6 @@ What you should *never* do:
- expect it to work when loadvm'ing
- write to the FAT directory on the host system while accessing it with the
guest system
-.. _nbd:
-
NBD access
~~~~~~~~~~
--
2.39.5
- [Stable-10.0.1 04/23] target/avr: Improve decode of LDS, STS, (continued)
- [Stable-10.0.1 04/23] target/avr: Improve decode of LDS, STS, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 07/23] target/mips: Fix MIPS16e translation, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 06/23] hw/core/cpu: gdb_arch_name string should not be freed, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 08/23] meson: Use has_header_symbol() to check getcpu(), Michael Tokarev, 2025/05/14
- [Stable-10.0.1 09/23] meson: Remove CONFIG_STATX and CONFIG_STATX_MNT_ID, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 10/23] meson: Share common C source prefixes, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 11/23] meson: Use osdep_prefix for strchrnul(), Michael Tokarev, 2025/05/14
- [Stable-10.0.1 13/23] hw/arm/npcm8xx_boards: Correct valid_cpu_types setting of NPCM8XX SoC, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 14/23] target/arm: Don't assert() for ISB/SB inside IT block, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 12/23] accel/tcg: Don't use TARGET_LONG_BITS in decode_sleb128, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 15/23] docs: Don't define duplicate label in qemu-block-drivers.rst.inc,
Michael Tokarev <=
- [Stable-10.0.1 20/23] xen: mapcache: Split mapcache_grants by ro and rw, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 18/23] target/i386: do not block singlestep for STI, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 21/23] hw/i2c/imx: Always set interrupt status bit if interrupt condition occurs, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 22/23] 9pfs: fix concurrent v9fs_reclaim_fd() calls, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 19/23] xen: mapcache: Fix finding matching entry, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 16/23] hw/gpio/imx_gpio: Fix interpretation of GDIR polarity, Michael Tokarev, 2025/05/14
- [Stable-10.0.1 23/23] 9pfs: fix FD leak and reduce latency of v9fs_reclaim_fd(), Michael Tokarev, 2025/05/14
- [Stable-10.0.1 17/23] target/i386: do not trigger IRQ shadow for LSS, Michael Tokarev, 2025/05/14