aboutsummaryrefslogtreecommitdiff
path: root/docs/devel
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daudé <philmd@redhat.com>2021-11-18 20:27:44 +0100
committerThomas Huth <thuth@redhat.com>2021-11-22 15:02:38 +0100
commitc5ba62195427d65a44472901cff3dddffc14b3b3 (patch)
tree4fa80766f3a461aec85f3ee70279d908056aa693 /docs/devel
parenteff708a876b40fe71bedb792d084972d7a52166a (diff)
downloadqemu-c5ba62195427d65a44472901cff3dddffc14b3b3.zip
qemu-c5ba62195427d65a44472901cff3dddffc14b3b3.tar.gz
qemu-c5ba62195427d65a44472901cff3dddffc14b3b3.tar.bz2
docs: Render binary names as monospaced text
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-Id: <20211118192744.64325-1-philmd@redhat.com> Reviewed-by: Darren Kenny <darren.kenny@oracle.com> Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'docs/devel')
-rw-r--r--docs/devel/build-system.rst6
-rw-r--r--docs/devel/multi-process.rst6
-rw-r--r--docs/devel/testing.rst8
3 files changed, 10 insertions, 10 deletions
diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst
index 7a83f5f..431caba 100644
--- a/docs/devel/build-system.rst
+++ b/docs/devel/build-system.rst
@@ -121,11 +121,11 @@ process for:
1) executables, which include:
- - Tools - qemu-img, qemu-nbd, qga (guest agent), etc
+ - Tools - ``qemu-img``, ``qemu-nbd``, ``qga`` (guest agent), etc
- - System emulators - qemu-system-$ARCH
+ - System emulators - ``qemu-system-$ARCH``
- - Userspace emulators - qemu-$ARCH
+ - Userspace emulators - ``qemu-$ARCH``
- Unit tests
diff --git a/docs/devel/multi-process.rst b/docs/devel/multi-process.rst
index 5c857ff..e480175 100644
--- a/docs/devel/multi-process.rst
+++ b/docs/devel/multi-process.rst
@@ -187,9 +187,9 @@ desired, in which the emulation application should only be allowed to
access the files or devices the VM it's running on behalf of can access.
#### qemu-io model
-Qemu-io is a test harness used to test changes to the QEMU block backend
-object code. (e.g., the code that implements disk images for disk driver
-emulation) Qemu-io is not a device emulation application per se, but it
+``qemu-io`` is a test harness used to test changes to the QEMU block backend
+object code (e.g., the code that implements disk images for disk driver
+emulation). ``qemu-io`` is not a device emulation application per se, but it
does compile the QEMU block objects into a separate binary from the main
QEMU one. This could be useful for disk device emulation, since its
emulation applications will need to include the QEMU block objects.
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 60c5902..755343c 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -564,11 +564,11 @@ exploiting a QEMU security bug to compromise the host.
QEMU binaries
~~~~~~~~~~~~~
-By default, qemu-system-x86_64 is searched in $PATH to run the guest. If there
-isn't one, or if it is older than 2.10, the test won't work. In this case,
+By default, ``qemu-system-x86_64`` is searched in $PATH to run the guest. If
+there isn't one, or if it is older than 2.10, the test won't work. In this case,
provide the QEMU binary in env var: ``QEMU=/path/to/qemu-2.10+``.
-Likewise the path to qemu-img can be set in QEMU_IMG environment variable.
+Likewise the path to ``qemu-img`` can be set in QEMU_IMG environment variable.
Make jobs
~~~~~~~~~
@@ -650,7 +650,7 @@ supported. To start the fuzzer, run
tests/image-fuzzer/runner.py -c '[["qemu-img", "info", "$test_img"]]' /tmp/test qcow2
-Alternatively, some command different from "qemu-img info" can be tested, by
+Alternatively, some command different from ``qemu-img info`` can be tested, by
changing the ``-c`` option.
Integration tests using the Avocado Framework