mirror of
https://github.com/xemu-project/xemu.git
synced 2024-11-23 11:39:53 +00:00
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>
This commit is contained in:
parent
8a48a7c2e0
commit
6df743dc31
@ -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::
|
||||
|
@ -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
|
||||
{
|
||||
|
@ -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/
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
^^^^^^^^^
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user