diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-26 15:23:33 +0100 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2021-08-02 11:42:38 +0100 |
commit | 1e235edab8df6d1cb6da5c726c2b8e2a2782e37b (patch) | |
tree | 23ed1c2be278d3949d25ad97eb14982e2c307168 /scsi | |
parent | 4df3a7bf8f895e356a3b1f4891489c1ffa5e1e46 (diff) |
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
Diffstat (limited to 'scsi')
0 files changed, 0 insertions, 0 deletions