Skip to content

Commit

Permalink
docs: remove non-reference uses of single backticks
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
jnsnow authored and elmarco committed Nov 5, 2021
1 parent f7b5d3a commit ff35c84
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
9 changes: 5 additions & 4 deletions docs/devel/fuzzing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/devel/tcg-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
2 changes: 1 addition & 1 deletion docs/interop/live-block-operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ at this point:
(QEMU) block-job-complete device=job0

In either of the above cases, if you once again run the
`query-block-jobs` command, there should not be any active block
``query-block-jobs`` command, there should not be any active block
operation.

Comparing 'commit' and 'mirror': In both then cases, the overlay images
Expand Down
2 changes: 1 addition & 1 deletion docs/system/guest-loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ The full syntax of the guest-loader is::

``bootargs=<args>``
This is an optional field for kernel blobs which will pass command
like via the `/chosen/module@<addr>/bootargs` node.
like via the ``/chosen/module@<addr>/bootargs`` node.
6 changes: 3 additions & 3 deletions include/qemu/module.h
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ void module_allow_arch(const char *arch);
/**
* DOC: module info annotation macros
*
* `scripts/modinfo-collect.py` will collect module info,
* ``scripts/modinfo-collect.py`` will collect module info,
* using the preprocessor and -DQEMU_MODINFO.
*
* `scripts/modinfo-generate.py` will create a module meta-data database
* ``scripts/modinfo-generate.py`` will create a module meta-data database
* from the collected information so qemu knows about module
* dependencies and QOM objects implemented by modules.
*
* See `*.modinfo` and `modinfo.c` in the build directory to check the
* See ``*.modinfo`` and ``modinfo.c`` in the build directory to check the
* script results.
*/
#ifdef QEMU_MODINFO
Expand Down
4 changes: 2 additions & 2 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -491,11 +491,11 @@
# @granularity: granularity of the dirty bitmap in bytes (since 1.4)
#
# @recording: true if the bitmap is recording new writes from the guest.
# Replaces `active` and `disabled` statuses. (since 4.0)
# Replaces ``active`` and ``disabled`` statuses. (since 4.0)
#
# @busy: true if the bitmap is in-use by some operation (NBD or jobs)
# and cannot be modified via QMP or used by another operation.
# Replaces `locked` and `frozen` statuses. (since 4.0)
# Replaces ``locked`` and ``frozen`` statuses. (since 4.0)
#
# @persistent: true if the bitmap was stored on disk, is scheduled to be stored
# on disk, or both. (since 4.0)
Expand Down
4 changes: 2 additions & 2 deletions qemu-options.hx
Original file line number Diff line number Diff line change
Expand Up @@ -1895,8 +1895,8 @@ SRST
Valid parameters are:

``grab-mod=<mods>`` : Used to select the modifier keys for toggling
the mouse grabbing in conjunction with the "g" key. `<mods>` can be
either `lshift-lctrl-lalt` or `rctrl`.
the mouse grabbing in conjunction with the "g" key. ``<mods>`` can be
either ``lshift-lctrl-lalt`` or ``rctrl``.

``alt_grab=on|off`` : Use Control+Alt+Shift-g to toggle mouse grabbing.
This parameter is deprecated - use ``grab-mod`` instead.
Expand Down

0 comments on commit ff35c84

Please sign in to comment.