aboutsummaryrefslogtreecommitdiffstats
path: root/docs/defs.rst.inc
diff options
context:
space:
mode:
authorTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2023-10-10 11:40:56 +0000
committerTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2023-10-10 11:40:56 +0000
commite02cda008591317b1625707ff8e115a4841aa889 (patch)
treeaee302e3cf8b59ec2d32ec481be3d1afddfc8968 /docs/defs.rst.inc
parentcc668e6b7e0ffd8c9d130513d12053cf5eda1d3b (diff)
Introduce Virtio-loopback epsilon release:
Epsilon release introduces a new compatibility layer which make virtio-loopback design to work with QEMU and rust-vmm vhost-user backend without require any changes. Signed-off-by: Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com> Change-Id: I52e57563e08a7d0bdc002f8e928ee61ba0c53dd9
Diffstat (limited to 'docs/defs.rst.inc')
-rw-r--r--docs/defs.rst.inc15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/defs.rst.inc b/docs/defs.rst.inc
new file mode 100644
index 000000000..52d6454b9
--- /dev/null
+++ b/docs/defs.rst.inc
@@ -0,0 +1,15 @@
+..
+ 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| and |qemu_system_x86| are 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
+.. |qemu_system_x86| replace:: qemu-system-x86_64
+.. |I2C| replace:: I\ :sup:`2`\ C
+.. |I2S| replace:: I\ :sup:`2`\ S