| commit | 6df743dc31a6a0b618042da2b550993c6e9767d1 | |
| author | Peter Maydell <peter.maydell@linaro.org> | |
| Mon, 26 Jul 2021 14:23:36 +0000 (26 15:23 +0100) | ||
| committer | Peter Maydell <peter.maydell@linaro.org> | |
| Mon, 2 Aug 2021 10:42:38 +0000 (2 11:42 +0100) | ||
| tree | 4ad64134692f4447da519e0b5647ddc1dbf55845 | treesnapshot (tar.gz zip) |
| parent | 8a48a7c2e004ac55c9397b3dd6cd3475a00b0f58 | commitdiff |
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>
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>