aboutsummaryrefslogtreecommitdiff
path: root/docs/system/riscv/microchip-icicle-kit.rst
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2021-07-26 15:23:36 +0100
committerPeter Maydell <peter.maydell@linaro.org>2021-08-02 11:42:38 +0100
commit6df743dc31a6a0b618042da2b550993c6e9767d1 (patch)
tree4ad64134692f4447da519e0b5647ddc1dbf55845 /docs/system/riscv/microchip-icicle-kit.rst
parent8a48a7c2e004ac55c9397b3dd6cd3475a00b0f58 (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/riscv/microchip-icicle-kit.rst')
-rw-r--r--docs/system/riscv/microchip-icicle-kit.rst2
1 files changed, 1 insertions, 1 deletions
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