summary refs log tree commit diff stats
path: root/docs/system
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2020-02-28 15:36:00 +0000
committerPeter Maydell <peter.maydell@linaro.org>2020-03-06 10:04:58 +0000
commitde1572ca4902c057b100d5c3434f254dfc677ddd (patch)
tree8e17979256b25425bf12ea603cb28beadfe845e3 /docs/system
parentbccb135e54f746c8e18dc6146c1a678dc670a05c (diff)
downloadfocaccia-qemu-de1572ca4902c057b100d5c3434f254dfc677ddd.tar.gz
focaccia-qemu-de1572ca4902c057b100d5c3434f254dfc677ddd.zip
docs: Create defs.rst.inc as a place to define substitutions
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
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/qemu-block-drivers.rst2
1 files changed, 0 insertions, 2 deletions
diff --git a/docs/system/qemu-block-drivers.rst b/docs/system/qemu-block-drivers.rst
index 7ca890ea23..bd99d4fa8e 100644
--- a/docs/system/qemu-block-drivers.rst
+++ b/docs/system/qemu-block-drivers.rst
@@ -3,8 +3,6 @@
 QEMU block drivers reference
 ============================
 
-.. |qemu_system| replace:: qemu-system-x86_64
-
 Synopsis
 --------