motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-04 00:03:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Create defs.rst.inc as a place to define substitutions

Browse source 
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
This commit is contained in:
Peter Maydell 2020-02-28 15:36:00 +00:00
parent bccb135e54
commit de1572ca49
4 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/defs.rst.inc Normal file
View file

@ -0,0 +1,11 @@
..
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