diff options
| author | John Snow <jsnow@redhat.com> | 2021-10-04 17:52:36 -0400 |
|---|---|---|
| committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2021-11-08 12:27:23 +0400 |
| commit | 450e0f28a476342baf1ed14a6c2a230e738f83bf (patch) | |
| tree | e1fbb3cf53a912b17c616329fa82a25bdc6d2c31 /docs/devel | |
| parent | 9423751645d27ae1146ca645431c368f09cb3b6c (diff) | |
| download | qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.zip qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.tar.gz qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.tar.bz2 | |
docs: remove non-reference uses of single backticks
The single backtick markup in ReST is the "default role". Currently,
Sphinx's default role is called "content". Sphinx suggests you can use
the "Any" role instead to turn any single-backtick enclosed item into a
cross-reference.
This is useful for things like autodoc for Python docstrings, where it's
often nicer to reference other types with `foo` instead of the more
laborious :py:meth:`foo`. It's also useful in multi-domain cases to
easily reference definitions from other Sphinx domains, such as
referencing C code definitions from outside of kerneldoc comments.
Before we do that, though, we'll need to turn all existing usages of the
"content" role to inline verbatim markup wherever it does not correctly
resolve into a cross-refernece by using double backticks instead.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Alexander Bulekov <alxndr@bu.edu>
Message-Id: <20211004215238.1523082-2-jsnow@redhat.com>
Diffstat (limited to 'docs/devel')
| -rw-r--r-- | docs/devel/fuzzing.rst | 9 | ||||
| -rw-r--r-- | docs/devel/tcg-plugins.rst | 2 |
2 files changed, 6 insertions, 5 deletions
diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst index 2749bb9..784ecb9 100644 --- a/docs/devel/fuzzing.rst +++ b/docs/devel/fuzzing.rst @@ -182,10 +182,11 @@ The output should contain a complete list of matched MemoryRegions. OSS-Fuzz -------- -QEMU is continuously fuzzed on `OSS-Fuzz` __(https://github.com/google/oss-fuzz). -By default, the OSS-Fuzz build will try to fuzz every fuzz-target. Since the -generic-fuzz target requires additional information provided in environment -variables, we pre-define some generic-fuzz configs in +QEMU is continuously fuzzed on `OSS-Fuzz +<https://github.com/google/oss-fuzz>`_. By default, the OSS-Fuzz build +will try to fuzz every fuzz-target. Since the generic-fuzz target +requires additional information provided in environment variables, we +pre-define some generic-fuzz configs in ``tests/qtest/fuzz/generic_fuzz_configs.h``. Each config must specify: - ``.name``: To identify the fuzzer config diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 59a7d83..f93ef4f 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -211,7 +211,7 @@ The hotpages plugin can be configured using the following arguments: This is an instruction classifier so can be used to count different types of instructions. It has a number of options to refine which get -counted. You can give a value to the `count` argument for a class of +counted. You can give a value to the ``count`` argument for a class of instructions to break it down fully, so for example to see all the system registers accesses:: |