Skip to contentSkip to conversation

docs/sphinx: change default `role` to "any"

PATCH Superseded John Snow 3 participants 5 messages Aug 5, 2021

v1 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

John Snow

author
#0 lore raw

cover docs/sphinx: change default `role` to "any"

The first patch that I've been carrying for quite a while got real small recently ... Apologies to Peter Maydell who re-did all that work.

John Snow (2):
docs: remove non-reference uses of single backticks docs/sphinx: change default role to "any"

 docs/conf.py                           |  3 +++
 docs/devel/fuzzing.rst                 | 10 ++++++----
 docs/interop/live-block-operations.rst |  2 +-
 docs/system/guest-loader.rst           |  2 +-
 qapi/block-core.json                   |  4 ++--
 include/qemu/module.h                  |  6 +++---
 6 files changed, 16 insertions(+), 11 deletions(-)
Signature · 1 line
2.31.1
author
#1 lore raw

PATCH 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.

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                 | 10 ++++++----
 docs/interop/live-block-operations.rst |  2 +-
 docs/system/guest-loader.rst           |  2 +-
 qapi/block-core.json                   |  4 ++--
 include/qemu/module.h                  |  6 +++---
 5 files changed, 13 insertions(+), 11 deletions(-)
docs/devel/fuzzing.rst +6 -4
index 2749bb9bed3..5f735bb1e91 100644
@@ -182,10 +182,12 @@ 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/interop/live-block-operations.rst +1 -1
index 9e3635b2338..814c29bbe1d 100644
@@ -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
index 4320d1183f7..9ef9776bf07 100644
@@ -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
index 675d8265ebf..4246a44da71 100644
@@ -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
index 3deac0078b9..5fcc323b2a7 100644
@@ -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
Signature · 1 line
2.31.1
Reviewed-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] docs: remove non-reference uses of single backticks

Quoted 10 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 foo instead of the more laborious :py:meth:foo.

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.

thanks
-- PMM

author
#3 lore raw

PATCH 2/2 docs/sphinx: change default role to "any"

In reply to John Snow

This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols. If it doesn't resolve, or resolves to too more than one thing, Sphinx will emit a warning and the build will fail.

---
 docs/conf.py | 3 +++
 1 file changed, 3 insertions(+)
docs/conf.py +3 -0
index ff6e92c6e2e..acaf883704a 100644
@@ -85,6 +85,9 @@
 # The master toctree document.
 master_doc = 'index'
 
+# Interpret `this` to be a cross-reference to "anything".
+default_role = 'any'
+
 # General information about the project.
 project = u'QEMU'
 copyright = u'2021, The QEMU Project Developers'
Signature · 1 line
2.31.1
#4 lore raw

Re: [PATCH 2/2] docs/sphinx: change default role to "any"

Quoted 3 lines · John Snow

This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols. If it doesn't resolve, or resolves to too more than one thing, Sphinx will emit a

s/too //

Quoted 7 lines

warning and the build will fail.

---
 docs/conf.py | 3 +++
 1 file changed, 3 insertions(+)
Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org