[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/21] docs/devel: Format literals correctly
From: |
Peter Maydell |
Subject: |
[PULL 11/21] docs/devel: Format literals correctly |
Date: |
Mon, 2 Aug 2021 12:58:02 +0100 |
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
---
docs/devel/qgraph.rst | 8 ++++----
docs/devel/tcg-plugins.rst | 14 +++++++-------
docs/devel/testing.rst | 8 ++++----
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/devel/qgraph.rst b/docs/devel/qgraph.rst
index 318534d4b08..39e293687e6 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
^^^^^^^^^^^^^^^
diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
index 7e54f128375..047bf4ada7c 100644
--- a/docs/devel/tcg-plugins.rst
+++ b/docs/devel/tcg-plugins.rst
@@ -34,11 +34,11 @@ version they were built against. This can be done simply
by::
QEMU_PLUGIN_EXPORT int qemu_plugin_version = QEMU_PLUGIN_VERSION;
The core code will refuse to load a plugin that doesn't export a
-`qemu_plugin_version` symbol or if plugin version is outside of QEMU's
+``qemu_plugin_version`` symbol or if plugin version is outside of QEMU's
supported range of API versions.
-Additionally the `qemu_info_t` structure which is passed to the
-`qemu_plugin_install` method of a plugin will detail the minimum and
+Additionally the ``qemu_info_t`` structure which is passed to the
+``qemu_plugin_install`` method of a plugin will detail the minimum and
current API versions supported by QEMU. The API version will be
incremented if new APIs are added. The minimum API version will be
incremented if existing APIs are changed or removed.
@@ -146,12 +146,12 @@ Example Plugins
There are a number of plugins included with QEMU and you are
encouraged to contribute your own plugins plugins upstream. There is a
-`contrib/plugins` directory where they can go.
+``contrib/plugins`` directory where they can go.
- tests/plugins
These are some basic plugins that are used to test and exercise the
-API during the `make check-tcg` target.
+API during the ``make check-tcg`` target.
- contrib/plugins/hotblocks.c
@@ -163,7 +163,7 @@ with linux-user execution as system emulation tends to
generate
re-translations as blocks from different programs get swapped in and
out of system memory.
-If your program is single-threaded you can use the `inline` option for
+If your program is single-threaded you can use the ``inline`` option for
slightly faster (but not thread safe) counters.
Example::
@@ -251,7 +251,7 @@ which will lead to a sorted list after the class breakdown::
...
To find the argument shorthand for the class you need to examine the
-source code of the plugin at the moment, specifically the `*opt`
+source code of the plugin at the moment, specifically the ``*opt``
argument in the InsnClassExecCount tables.
- contrib/plugins/lockstep.c
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 8f572255d32..8a9cda33a5d 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -775,7 +775,7 @@ The base test class has also support for tests with more
than one
QEMUMachine. The way to get machines is through the ``self.get_vm()``
method which will return a QEMUMachine instance. The ``self.get_vm()``
method accepts arguments that will be passed to the QEMUMachine creation
-and also an optional `name` attribute so you can identify a specific
+and also an optional ``name`` attribute so you can identify a specific
machine and get it more than once through the tests methods. A simple
and hypothetical example follows:
@@ -1062,7 +1062,7 @@ Here is a list of the most used variables:
AVOCADO_ALLOW_LARGE_STORAGE
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Tests which are going to fetch or produce assets considered *large* are not
-going to run unless that `AVOCADO_ALLOW_LARGE_STORAGE=1` is exported on
+going to run unless that ``AVOCADO_ALLOW_LARGE_STORAGE=1`` is exported on
the environment.
The definition of *large* is a bit arbitrary here, but it usually means an
@@ -1076,7 +1076,7 @@ skipped by default. The definition of *not safe* is also
arbitrary but
usually it means a blob which either its source or build process aren't
public available.
-You should export `AVOCADO_ALLOW_UNTRUSTED_CODE=1` on the environment in
+You should export ``AVOCADO_ALLOW_UNTRUSTED_CODE=1`` on the environment in
order to allow tests which make use of those kind of assets.
AVOCADO_TIMEOUT_EXPECTED
@@ -1090,7 +1090,7 @@ property defined in the test class, for further details::
Even though the timeout can be set by the test developer, there are some tests
that may not have a well-defined limit of time to finish under certain
conditions. For example, tests that take longer to execute when QEMU is
-compiled with debug flags. Therefore, the `AVOCADO_TIMEOUT_EXPECTED` variable
+compiled with debug flags. Therefore, the ``AVOCADO_TIMEOUT_EXPECTED`` variable
has been used to determine whether those tests should run or not.
GITLAB_CI
--
2.20.1
- [PULL 02/21] docs: Add documentation of Arm 'kzm' board, (continued)
- [PULL 02/21] docs: Add documentation of Arm 'kzm' board, Peter Maydell, 2021/08/02
- [PULL 03/21] docs: Add documentation of Arm 'imx25-pdk' board, Peter Maydell, 2021/08/02
- [PULL 05/21] docs: Remove stale TODO comments about license and version, Peter Maydell, 2021/08/02
- [PULL 08/21] docs/devel/build-system.rst: Correct typo in example code, Peter Maydell, 2021/08/02
- [PULL 09/21] docs/devel/ebpf_rss.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 10/21] docs/devel/migration.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 07/21] docs/devel/build-system.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 12/21] docs/system/s390x/protvirt.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 14/21] docs: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 16/21] docs/tools/virtiofsd.rst: Delete stray backtick, Peter Maydell, 2021/08/02
- [PULL 11/21] docs/devel: Format literals correctly,
Peter Maydell <=
- [PULL 13/21] docs/system/arm/cpu-features.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 17/21] hw/arm/boot: Report error if there is no fw_cfg device in the machine, Peter Maydell, 2021/08/02
- [PULL 15/21] docs/about/removed-features: Fix markup error, Peter Maydell, 2021/08/02
- [PULL 18/21] docs: Move bootindex.txt into system section and rstify, Peter Maydell, 2021/08/02
- [PULL 21/21] docs: Move user-facing barrier docs into system manual, Peter Maydell, 2021/08/02
- [PULL 19/21] docs: Move the protocol part of barrier.txt into interop, Peter Maydell, 2021/08/02
- [PULL 20/21] ui/input-barrier: Move TODOs from barrier.txt to a comment, Peter Maydell, 2021/08/02
- Re: [PULL 00/21] target-arm queue, Peter Maydell, 2021/08/02