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/testing.rst | |
| parent | 4df3a7bf8f895e356a3b1f4891489c1ffa5e1e46 (diff) | |
| download | qemu-1e235edab8df6d1cb6da5c726c2b8e2a2782e37b.zip qemu-1e235edab8df6d1cb6da5c726c2b8e2a2782e37b.tar.gz qemu-1e235edab8df6d1cb6da5c726c2b8e2a2782e37b.tar.bz2 | |
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/testing.rst')
| -rw-r--r-- | docs/devel/testing.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst index 8f57225..8a9cda3 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 |