diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-26 15:23:29 +0100 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2021-08-02 11:42:38 +0100 |
commit | 35a4ca403145c9412c5fc042fd2baa20bc21b858 (patch) | |
tree | f2793f76a9bd738df2f692470290630d518f256b /LICENSE | |
parent | 4e0b15c25228d14c55bdd482e11a1b351d00191b (diff) | |
download | qemu-35a4ca403145c9412c5fc042fd2baa20bc21b858.zip qemu-35a4ca403145c9412c5fc042fd2baa20bc21b858.tar.gz qemu-35a4ca403145c9412c5fc042fd2baa20bc21b858.tar.bz2 |
docs/devel/build-system.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).
build-system.rst seems to have been written under the mistaken
assumption that single-backticks mark up literal text (function
names, etc) which should be rendered in a fixed-width font.
The rST markup for this is ``double backticks``.
Update all the markup.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-id: 20210726142338.31872-2-peter.maydell@linaro.org
Diffstat (limited to 'LICENSE')
0 files changed, 0 insertions, 0 deletions