qemu/docs/system/i386
David Woodhouse 1eeb432a95 doc/sphinx/hxtool.py: add optional label argument to SRST directive
We can't just embed labels directly into files like qemu-options.hx which
are included from multiple top-level rST files, because Sphinx sees the
labels as duplicate: https://github.com/sphinx-doc/sphinx/issues/9707

So add an optional argument to the SRST directive which causes a label
of the form '.. _DOCNAME-HXFILE-LABEL:' to be emitted, where 'DOCNAME'
is the name of the top level rST file, 'HXFILE' is the filename of the
.hx file, and 'LABEL' is the text provided within the 'SRST()' directive.
Using the DOCNAME of the top-level rST document means that it is unique
even when the .hx file is included from two different documents, as is
the case for qemu-options.hx

Now where the Xen PV documentation refers to the documentation for the
-initrd command line option, it can emit a link directly to it as
'<system/invocation-qemu-options-initrd>'.

Signed-off-by: David Woodhouse <dwmw@amazon.co.uk>
Reviewed-by: Paul Durrant <paul@xen.org>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20240130190348.682912-1-dwmw2@infradead.org
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
2024-02-02 13:51:58 +00:00
..
amd-memory-encryption.rst Update AMD memory encryption document links. 2023-10-11 14:19:45 +03:00
cpu.rst docs/system: move x86 CPU configuration to a separate document 2021-09-13 13:56:26 +02:00
hyperv.rst i386: docs: Convert hyperv.txt to rST 2022-05-25 21:26:35 +02:00
kvm-pv.rst i386: docs: Briefly describe KVM PV features 2021-10-05 12:47:24 +02:00
microvm.rst docs: Move microvm.rst into the system manual 2020-11-23 11:10:04 +00:00
pc.rst docs: Split out 'pc' machine model docs into their own file 2020-11-23 11:09:42 +00:00
sgx.rst doc: Add the SGX numa description 2021-12-10 09:47:18 +01:00
xen.rst doc/sphinx/hxtool.py: add optional label argument to SRST directive 2024-02-02 13:51:58 +00:00