docs/sphinx: change default `role` to "any"
v3 cover docs/sphinx: change default `role` to "any"
Rebased to not let the work done in removing erroneous references prior to 6.1 regress.
V3: Removed bad rebase confetti
fixed the OSS-Fuzz link to ... actually be a link.
John Snow (2):
docs: remove non-reference uses of single backticks docs/sphinx: change default role to "any"
docs/conf.py | 5 +++++ docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 8 files changed, 20 insertions(+), 14 deletions(-)
Signature · 1 line
2.31.1
PATCH v3 1/2 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.
--- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-)
docs/devel/fuzzing.rst +5 -4
@@ -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
docs/devel/tcg-plugins.rst +1 -1
@@ -212,7 +212,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::
docs/interop/live-block-operations.rst +1 -1
@@ -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
docs/system/guest-loader.rst +1 -1
@@ -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.
qapi/block-core.json +2 -2
@@ -446,11 +446,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)
include/qemu/module.h +3 -3
@@ -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
qemu-options.hx +2 -2
@@ -1881,8 +1881,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.
Signature · 1 line
2.31.1
Re: [PATCH v3 1/2] docs: remove non-reference uses of single backticks
Quoted 31 lines · John Snow
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
fooinstead 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 <[email protected]>--- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-)docs/devel/fuzzing.rst +0
-0
docs/devel/fuzzing.rst The output should contain a complete list of matched MemoryRegions. · line 186
Quoted 9 lines
docs/devel/fuzzing.rst +2
-4@@ -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
Gosh, I think I'll never understand the syntax for links in reStructuredText.
Quoted 4 lines
docs/devel/fuzzing.rst +3
-0+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:
[...]
Signature · 1 line
Eduardo
Re: [PATCH v3 1/2] docs: remove non-reference uses of single backticks
In reply to John SnowQuoted 11 lines · John Snow
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
fooinstead 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.
Quoted 5 lines
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 <[email protected]>
Thanks!
Quoted 124 lines
--- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-)docs/devel/fuzzing.rst +5
-4@@ -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 configdocs/devel/tcg-plugins.rst +1
-1@@ -212,7 +212,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::docs/interop/live-block-operations.rst +1
-1@@ -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 imagesdocs/system/guest-loader.rst +1
-1@@ -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.qapi/block-core.json +2
-2@@ -446,11 +446,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)include/qemu/module.h +3
-3@@ -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 qemu-options.hx +2
-2@@ -1881,8 +1881,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.Signature · 1 line
2.31.1
PATCH v3 2/2 docs/sphinx: change default role to "any"
In reply to John SnowThis interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols.
From here on out, new uses of backticks will cause a build failure if the target cannot be referenced.
--- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+)
docs/conf.py +5 -0
@@ -85,6 +85,11 @@ # The master toctree document. master_doc = 'index' +# Interpret `single-backticks` to be a cross-reference to any kind of +# referenceable object. Unresolvable or ambiguous references will emit a +# warning at build time. +default_role = 'any' + # General information about the project. project = u'QEMU' copyright = u'2021, The QEMU Project Developers'
Signature · 1 line
2.31.1
Re: [PATCH v3 2/2] docs/sphinx: change default role to "any"
Quoted 7 lines · John Snow
This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols.
From here on out, new uses of
backtickswill cause a build failure if the target cannot be referenced.Signed-off-by John Snow <[email protected]>
Patch 1/2 demonstrates why patch 2/2 is useful.
Quoted 23 lines
--- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+)docs/conf.py +5
-0@@ -85,6 +85,11 @@ # The master toctree document. master_doc = 'index' +# Interpret `single-backticks` to be a cross-reference to any kind of +# referenceable object. Unresolvable or ambiguous references will emit a +# warning at build time. +default_role = 'any' + # General information about the project. project = u'QEMU' copyright = u'2021, The QEMU Project Developers'Signature · 1 line
2.31.1
Signature · 1 line
Eduardo
Re: [PATCH v3 2/2] docs/sphinx: change default role to "any"
In reply to John SnowQuoted 10 lines · John Snow
This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols.
From here on out, new uses of
backtickswill cause a build failure if the target cannot be referenced.Signed-off-by John Snow <[email protected]>--- docs/conf.py | 5 +++++
thanks
-- PMM