docs/devel: Format literals correctly
commit1e235edab8df6d1cb6da5c726c2b8e2a2782e37b
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 26 Jul 2021 14:23:33 +0000 (26 15:23 +0100)
committerPeter Maydell <peter.maydell@linaro.org>
Mon, 2 Aug 2021 10:42:38 +0000 (2 11:42 +0100)
tree23ed1c2be278d3949d25ad97eb14982e2c307168
parent4df3a7bf8f895e356a3b1f4891489c1ffa5e1e46
docs/devel: 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).

Fix various places in the devel section of the manual which were
using single backticks when double backticks (for literal text)
were intended.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210726142338.31872-6-peter.maydell@linaro.org
docs/devel/qgraph.rst
docs/devel/tcg-plugins.rst
docs/devel/testing.rst