diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-26 15:23:35 +0100 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2021-08-02 11:42:38 +0100 |
commit | 8a48a7c2e004ac55c9397b3dd6cd3475a00b0f58 (patch) | |
tree | aa6df06129e60e87c627ed56ea802319c66ce723 /docs/about | |
parent | 9c372ecfec5bd00f7ef5b6b2e9db9c2c859b408b (diff) |
docs/system/arm/cpu-features.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.
cpu-features.rst consistently uses single backticks when double backticks
are required; correct it.
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-8-peter.maydell@linaro.org
Diffstat (limited to 'docs/about')
0 files changed, 0 insertions, 0 deletions