From 1e235edab8df6d1cb6da5c726c2b8e2a2782e37b Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Mon, 26 Jul 2021 15:23:33 +0100 Subject: docs/devel: Format literals correctly MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 ... (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 Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-6-peter.maydell@linaro.org --- docs/devel/qgraph.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/devel/qgraph.rst') diff --git a/docs/devel/qgraph.rst b/docs/devel/qgraph.rst index 318534d4b0..39e293687e 100644 --- a/docs/devel/qgraph.rst +++ b/docs/devel/qgraph.rst @@ -66,11 +66,11 @@ Notes for the nodes: Edges ^^^^^^ -An edge relation between two nodes (drivers or machines) `X` and `Y` can be: +An edge relation between two nodes (drivers or machines) ``X`` and ``Y`` can be: -- ``X CONSUMES Y``: `Y` can be plugged into `X` -- ``X PRODUCES Y``: `X` provides the interface `Y` -- ``X CONTAINS Y``: `Y` is part of `X` component +- ``X CONSUMES Y``: ``Y`` can be plugged into ``X`` +- ``X PRODUCES Y``: ``X`` provides the interface ``Y`` +- ``X CONTAINS Y``: ``Y`` is part of ``X`` component Execution steps ^^^^^^^^^^^^^^^ -- cgit 1.4.1