diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-26 15:23:36 +0100 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2021-08-02 11:42:38 +0100 |
| commit | 6df743dc31a6a0b618042da2b550993c6e9767d1 (patch) | |
| tree | 4ad64134692f4447da519e0b5647ddc1dbf55845 /docs/system/guest-loader.rst | |
| parent | 8a48a7c2e004ac55c9397b3dd6cd3475a00b0f58 (diff) | |
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/system/guest-loader.rst')
| -rw-r--r-- | docs/system/guest-loader.rst | 6 |
1 files changed, 3 insertions, 3 deletions
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 ^^^^^^^^^ |