diff options
author | Peter Maydell | 2021-07-26 16:23:36 +0200 |
---|---|---|
committer | Peter Maydell | 2021-08-02 12:42:38 +0200 |
commit | 6df743dc31a6a0b618042da2b550993c6e9767d1 (patch) | |
tree | 4ad64134692f4447da519e0b5647ddc1dbf55845 /docs | |
parent | docs/system/arm/cpu-features.rst: Format literals correctly (diff) | |
download | qemu-6df743dc31a6a0b618042da2b550993c6e9767d1.tar.gz qemu-6df743dc31a6a0b618042da2b550993c6e9767d1.tar.xz qemu-6df743dc31a6a0b618042da2b550993c6e9767d1.zip |
docs: Format literals correctly
In rST markup, single backticks `like this` represent "interpreted
text", which can be handled as a bunch of different things if tagged
with a specific "role":
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text
(the most common one for us is "reference to a URL, which gets
hyperlinked").
The default "role" if none is specified is "title_reference",
intended for references to book or article titles, and it renders
into the HTML as <cite>...</cite> (usually comes out as italics).
This commit fixes various places in the manual which were
using single backticks when double backticks (for literal text)
were intended, and covers those files where only one or two
instances of these errors were made.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/about/index.rst | 2 | ||||
-rw-r--r-- | docs/interop/live-block-operations.rst | 2 | ||||
-rw-r--r-- | docs/system/arm/nuvoton.rst | 2 | ||||
-rw-r--r-- | docs/system/arm/sbsa.rst | 4 | ||||
-rw-r--r-- | docs/system/arm/virt.rst | 2 | ||||
-rw-r--r-- | docs/system/cpu-hotplug.rst | 2 | ||||
-rw-r--r-- | docs/system/guest-loader.rst | 6 | ||||
-rw-r--r-- | docs/system/ppc/powernv.rst | 8 | ||||
-rw-r--r-- | docs/system/riscv/microchip-icicle-kit.rst | 2 | ||||
-rw-r--r-- | docs/system/riscv/virt.rst | 2 |
10 files changed, 16 insertions, 16 deletions
diff --git a/docs/about/index.rst b/docs/about/index.rst index 689a9861dc..beb762aa0a 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -15,7 +15,7 @@ where QEMU can launch processes compiled for one CPU on another CPU. In this mode the CPU is always emulated. QEMU also provides a number of standalone commandline utilities, -such as the `qemu-img` disk image utility that allows you to create, +such as the ``qemu-img`` disk image utility that allows you to create, convert and modify disk images. .. toctree:: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-operations.rst index 477d085f54..9e3635b233 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -781,7 +781,7 @@ the content of image [D]. } (6) [On *destination* QEMU] Finally, resume the guest vCPUs by issuing the - QMP command `cont`:: + QMP command ``cont``:: (QEMU) cont { diff --git a/docs/system/arm/nuvoton.rst b/docs/system/arm/nuvoton.rst index 3cd2b2b18d..69f57c2886 100644 --- a/docs/system/arm/nuvoton.rst +++ b/docs/system/arm/nuvoton.rst @@ -79,7 +79,7 @@ Boot options ------------ The Nuvoton machines can boot from an OpenBMC firmware image, or directly into -a kernel using the ``-kernel`` option. OpenBMC images for `quanta-gsj` and +a kernel using the ``-kernel`` option. OpenBMC images for ``quanta-gsj`` and possibly others can be downloaded from the OpenPOWER jenkins : https://openpower.xyz/ diff --git a/docs/system/arm/sbsa.rst b/docs/system/arm/sbsa.rst index 27b0999aac..b499d7e927 100644 --- a/docs/system/arm/sbsa.rst +++ b/docs/system/arm/sbsa.rst @@ -1,8 +1,8 @@ Arm Server Base System Architecture Reference board (``sbsa-ref``) ================================================================== -While the `virt` board is a generic board platform that doesn't match -any real hardware the `sbsa-ref` board intends to look like real +While the ``virt`` board is a generic board platform that doesn't match +any real hardware the ``sbsa-ref`` board intends to look like real hardware. The `Server Base System Architecture <https://developer.arm.com/documentation/den0029/latest>`_ defines a minimum base line of hardware support and importantly how the firmware diff --git a/docs/system/arm/virt.rst b/docs/system/arm/virt.rst index 27652adfae..59acf0eeaf 100644 --- a/docs/system/arm/virt.rst +++ b/docs/system/arm/virt.rst @@ -1,7 +1,7 @@ 'virt' generic virtual platform (``virt``) ========================================== -The `virt` board is a platform which does not correspond to any +The ``virt`` board is a platform which does not correspond to any real hardware; it is designed for use in virtual machines. It is the recommended board type if you simply want to run a guest such as Linux and do not care about reproducing the diff --git a/docs/system/cpu-hotplug.rst b/docs/system/cpu-hotplug.rst index bd0663616e..015ce2b6ec 100644 --- a/docs/system/cpu-hotplug.rst +++ b/docs/system/cpu-hotplug.rst @@ -78,7 +78,7 @@ vCPU hotplug } (QEMU) -(5) Optionally, run QMP `query-cpus-fast` for some details about the +(5) Optionally, run QMP ``query-cpus-fast`` for some details about the vCPUs:: (QEMU) query-cpus-fast diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 37d03cbd89..4320d1183f 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -4,7 +4,7 @@ Guest Loader ------------ -The guest loader is similar to the `generic-loader` although it is +The guest loader is similar to the ``generic-loader`` although it is aimed at a particular use case of loading hypervisor guests. This is useful for debugging hypervisors without having to jump through the hoops of firmware and boot-loaders. @@ -27,12 +27,12 @@ multi-boot capability. A typical example would look like: In the above example the Xen hypervisor is loaded by the -kernel parameter and passed it's boot arguments via -append. The Dom0 guest is loaded into the areas of memory. Each blob will get -`/chosen/module@<addr>` entry in the FDT to indicate it's location and +``/chosen/module@<addr>`` entry in the FDT to indicate it's location and size. Additional information can be passed with by using additional arguments. Currently the only supported machines which use FDT data to boot are -the ARM and RiscV `virt` machines. +the ARM and RiscV ``virt`` machines. Arguments ^^^^^^^^^ diff --git a/docs/system/ppc/powernv.rst b/docs/system/ppc/powernv.rst index 43c58bc32e..4c4cdea527 100644 --- a/docs/system/ppc/powernv.rst +++ b/docs/system/ppc/powernv.rst @@ -48,15 +48,15 @@ Firmware -------- The OPAL firmware (OpenPower Abstraction Layer) for OpenPower systems -includes the runtime services `skiboot` and the bootloader kernel and -initramfs `skiroot`. Source code can be found on GitHub: +includes the runtime services ``skiboot`` and the bootloader kernel and +initramfs ``skiroot``. Source code can be found on GitHub: https://github.com/open-power. -Prebuilt images of `skiboot` and `skiboot` are made available on the `OpenPOWER <https://openpower.xyz/job/openpower/job/openpower-op-build/>`__ site. To boot a POWER9 machine, use the `witherspoon <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=witherspoon/lastSuccessfulBuild/>`__ images. For POWER8, use +Prebuilt images of ``skiboot`` and ``skiboot`` are made available on the `OpenPOWER <https://openpower.xyz/job/openpower/job/openpower-op-build/>`__ site. To boot a POWER9 machine, use the `witherspoon <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=witherspoon/lastSuccessfulBuild/>`__ images. For POWER8, use the `palmetto <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=palmetto/lastSuccessfulBuild/>`__ images. -QEMU includes a prebuilt image of `skiboot` which is updated when a +QEMU includes a prebuilt image of ``skiboot`` which is updated when a more recent version is required by the models. Boot options diff --git a/docs/system/riscv/microchip-icicle-kit.rst b/docs/system/riscv/microchip-icicle-kit.rst index 817d2aec9c..40798b1aae 100644 --- a/docs/system/riscv/microchip-icicle-kit.rst +++ b/docs/system/riscv/microchip-icicle-kit.rst @@ -95,7 +95,7 @@ Then we can boot the machine by: -serial chardev:serial1 With above command line, current terminal session will be used for the first -serial port. Open another terminal window, and use `minicom` to connect the +serial port. Open another terminal window, and use ``minicom`` to connect the second serial port. .. code-block:: bash diff --git a/docs/system/riscv/virt.rst b/docs/system/riscv/virt.rst index 3709f05797..321d77e07d 100644 --- a/docs/system/riscv/virt.rst +++ b/docs/system/riscv/virt.rst @@ -1,7 +1,7 @@ 'virt' Generic Virtual Platform (``virt``) ========================================== -The `virt` board is a platform which does not correspond to any real hardware; +The ``virt`` board is a platform which does not correspond to any real hardware; it is designed for use in virtual machines. It is the recommended board type if you simply want to run a guest such as Linux and do not care about reproducing the idiosyncrasies and limitations of a particular bit of |