docs: Create defs.rst.inc as a place to define substitutions
commitde1572ca4902c057b100d5c3434f254dfc677ddd
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 28 Feb 2020 15:36:00 +0000 (28 15:36 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Fri, 6 Mar 2020 10:04:58 +0000 (6 10:04 +0000)
tree8e17979256b25425bf12ea603cb28beadfe845e3
parentbccb135e54f746c8e18dc6146c1a678dc670a05c
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
Makefile
docs/conf.py
docs/defs.rst.inc [new file with mode: 0644]
docs/system/qemu-block-drivers.rst