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 /docs/devel/qgraph.rst | |
| parent | 4df3a7bf8f895e356a3b1f4891489c1ffa5e1e46 (diff) | |
| download | focaccia-qemu-1e235edab8df6d1cb6da5c726c2b8e2a2782e37b.tar.gz focaccia-qemu-1e235edab8df6d1cb6da5c726c2b8e2a2782e37b.zip | |
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 'docs/devel/qgraph.rst')
| -rw-r--r-- | docs/devel/qgraph.rst | 8 |
1 files changed, 4 insertions, 4 deletions
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 ^^^^^^^^^^^^^^^ |