OSDN Git Service

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

To format a literal (generally rendered as fixed-width font),
double-backticks are required.

Mostly migration.rst gets this right, but some places incorrectly use
single backticks where double backticks were intended; correct them.

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>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-id: 20210726142338.31872-5-peter.maydell@linaro.org
docs/devel/migration.rst