mirror of
https://github.com/qemu/qemu.git
synced 2024-11-30 07:13:38 +08:00
de1572ca49
Rather than accumulating generally useful rST substitution definitions in individual rST files, create a defs.rst.inc where we can define these. To start with it has the |qemu_system| definition from qemu-block-drivers.rst. Add a comment noting a pitfall where putting literal markup in the definition of |qemu_system| makes it misrender manpage output; this means the point-of-use must handle the literal markup (which is almost always done by having it inside a parsed-literal block). Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Tested-by: Alex Bennée <alex.bennee@linaro.org> Message-id: 20200228153619.9906-15-peter.maydell@linaro.org
12 lines
543 B
PHP
12 lines
543 B
PHP
..
|
|
Generally useful rST substitution definitions. This is included for
|
|
all rST files as part of the epilogue by docs/conf.py. conf.py
|
|
also defines some dynamically generated substitutions like CONFDIR.
|
|
|
|
Note that |qemu_system| is intended to be used inside a parsed-literal
|
|
block: the definition must not include extra literal formatting with
|
|
``..``: this works in the HTML output but the manpages will end up
|
|
misrendered with following normal text incorrectly in boldface.
|
|
|
|
.. |qemu_system| replace:: qemu-system-x86_64
|