* [PATCH v2 0/2] docs/sphinx: change default `role` to "any" @ 2021-09-23 18:22 John Snow 2021-09-23 18:22 ` [PATCH v2 1/2] docs: remove non-reference uses of single backticks John Snow 2021-09-23 18:22 ` [PATCH v2 2/2] docs/sphinx: change default role to "any" John Snow 0 siblings, 2 replies; 6+ messages in thread From: John Snow @ 2021-09-23 18:22 UTC (permalink / raw) To: qemu-devel Cc: Peter Maydell, Thomas Huth, Eduardo Habkost, Darren Kenny, Juan Quintela, Alex Bennée, Dr. David Alan Gilbert, Qiuhao Li, John Snow, Alexander Bulekov, Bandan Das, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster Rebased to not let the work done in removing erroneous references prior to 6.1 regress. 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/migration.rst | 10 +++++----- 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 ++-- 9 files changed, 25 insertions(+), 19 deletions(-) -- 2.31.1 ^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2 1/2] docs: remove non-reference uses of single backticks 2021-09-23 18:22 [PATCH v2 0/2] docs/sphinx: change default `role` to "any" John Snow @ 2021-09-23 18:22 ` John Snow 2021-09-23 18:31 ` Peter Maydell 2021-09-23 18:32 ` Eduardo Habkost 2021-09-23 18:22 ` [PATCH v2 2/2] docs/sphinx: change default role to "any" John Snow 1 sibling, 2 replies; 6+ messages in thread From: John Snow @ 2021-09-23 18:22 UTC (permalink / raw) To: qemu-devel Cc: Peter Maydell, Thomas Huth, Eduardo Habkost, Darren Kenny, Juan Quintela, Alex Bennée, Dr. David Alan Gilbert, Qiuhao Li, John Snow, Alexander Bulekov, Bandan Das, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster 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> --- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/migration.rst | 10 +++++----- 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(+), 19 deletions(-) diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst index 2749bb9bed3..d5fe9314c65 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/migration.rst b/docs/devel/migration.rst index 24012534827..6b1230f2d7f 100644 --- a/docs/devel/migration.rst +++ b/docs/devel/migration.rst @@ -403,8 +403,8 @@ version_id. And the function ``load_state_old()`` (if present) is able to load state from minimum_version_id_old to minimum_version_id. This function is deprecated and will be removed when no more users are left. -There are *_V* forms of many ``VMSTATE_`` macros to load fields for version dependent fields, -e.g. +There are *_V* forms of many ``VMSTATE_`` macros to load fields for +version dependent fields, e.g. .. code:: c @@ -819,9 +819,9 @@ Postcopy now works with hugetlbfs backed memory: Postcopy with shared memory --------------------------- -Postcopy migration with shared memory needs explicit support from the other -processes that share memory and from QEMU. There are restrictions on the type of -memory that userfault can support shared. +Postcopy migration with shared memory needs explicit support from the +other processes that share memory and from QEMU. There are restrictions +on the type of memory that userfault can support shared. The Linux kernel userfault support works on ``/dev/shm`` memory and on ``hugetlbfs`` (although the kernel doesn't provide an equivalent to ``madvise(MADV_DONTNEED)`` diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index dac5101a3c9..8bffff187f8 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -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:: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-operations.rst index 9e3635b2338..814c29bbe1d 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -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 diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 4320d1183f7..9ef9776bf07 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -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. diff --git a/qapi/block-core.json b/qapi/block-core.json index c8ce1d9d5d8..0c64470edb2 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -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) diff --git a/include/qemu/module.h b/include/qemu/module.h index 3deac0078b9..5fcc323b2a7 100644 --- a/include/qemu/module.h +++ b/include/qemu/module.h @@ -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 diff --git a/qemu-options.hx b/qemu-options.hx index 8f603cc7e65..757ac6f2037 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -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. -- 2.31.1 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks 2021-09-23 18:22 ` [PATCH v2 1/2] docs: remove non-reference uses of single backticks John Snow @ 2021-09-23 18:31 ` Peter Maydell 2021-09-23 18:32 ` Eduardo Habkost 1 sibling, 0 replies; 6+ messages in thread From: Peter Maydell @ 2021-09-23 18:31 UTC (permalink / raw) To: John Snow Cc: Qiuhao Li, Thomas Huth, Eduardo Habkost, Darren Kenny, Juan Quintela, Alex Bennée, QEMU Developers, Dr. David Alan Gilbert, Alexander Bulekov, Bandan Das, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster On Thu, 23 Sept 2021 at 19:22, John Snow <jsnow@redhat.com> wrote: > > 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> > diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst > index 2749bb9bed3..d5fe9314c65 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 This is supposed to be a link and I don't think it's intended to be fixed-width font formatting, so I don't think this is the correct syntax fix. > +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/migration.rst b/docs/devel/migration.rst > index 24012534827..6b1230f2d7f 100644 > --- a/docs/devel/migration.rst > +++ b/docs/devel/migration.rst > @@ -403,8 +403,8 @@ version_id. And the function ``load_state_old()`` (if present) is able to > load state from minimum_version_id_old to minimum_version_id. This > function is deprecated and will be removed when no more users are left. > > -There are *_V* forms of many ``VMSTATE_`` macros to load fields for version dependent fields, > -e.g. > +There are *_V* forms of many ``VMSTATE_`` macros to load fields for > +version dependent fields, e.g. This doesn't seem to be changing a `...` ? > .. code:: c > > @@ -819,9 +819,9 @@ Postcopy now works with hugetlbfs backed memory: > Postcopy with shared memory > --------------------------- > > -Postcopy migration with shared memory needs explicit support from the other > -processes that share memory and from QEMU. There are restrictions on the type of > -memory that userfault can support shared. > +Postcopy migration with shared memory needs explicit support from the > +other processes that share memory and from QEMU. There are restrictions > +on the type of memory that userfault can support shared. > This part doesn't seem to be changing any `...` use ? The rest looks OK. thanks -- PMM ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks 2021-09-23 18:22 ` [PATCH v2 1/2] docs: remove non-reference uses of single backticks John Snow 2021-09-23 18:31 ` Peter Maydell @ 2021-09-23 18:32 ` Eduardo Habkost 2021-09-23 18:45 ` John Snow 1 sibling, 1 reply; 6+ messages in thread From: Eduardo Habkost @ 2021-09-23 18:32 UTC (permalink / raw) To: John Snow Cc: Peter Maydell, Thomas Huth, Darren Kenny, Juan Quintela, Alex Bennée, qemu-devel, Dr. David Alan Gilbert, Alexander Bulekov, Bandan Das, Qiuhao Li, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster On Thu, Sep 23, 2021 at 02:22:03PM -0400, John Snow wrote: > 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> Clear demonstration of the usefulness of patch 2/2 (these occurrences of `foo` wouldn't have been added if the default role was "any" because "any" errors out on invalid references). However, it looks like there are unrelated changes: [...] > diff --git a/docs/devel/migration.rst b/docs/devel/migration.rst > index 24012534827..6b1230f2d7f 100644 > --- a/docs/devel/migration.rst > +++ b/docs/devel/migration.rst > @@ -403,8 +403,8 @@ version_id. And the function ``load_state_old()`` (if present) is able to > load state from minimum_version_id_old to minimum_version_id. This > function is deprecated and will be removed when no more users are left. > > -There are *_V* forms of many ``VMSTATE_`` macros to load fields for version dependent fields, > -e.g. > +There are *_V* forms of many ``VMSTATE_`` macros to load fields for > +version dependent fields, e.g. Unrelated? Line wrapping change only. > > .. code:: c > > @@ -819,9 +819,9 @@ Postcopy now works with hugetlbfs backed memory: > Postcopy with shared memory > --------------------------- > > -Postcopy migration with shared memory needs explicit support from the other > -processes that share memory and from QEMU. There are restrictions on the type of > -memory that userfault can support shared. > +Postcopy migration with shared memory needs explicit support from the > +other processes that share memory and from QEMU. There are restrictions > +on the type of memory that userfault can support shared. Unrelated? Line wrapping change only. Reviewed-by: Eduardo Habkost <ehabkost@redhat.com> # if unrelated line wrapping changes are dropped -- Eduardo ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks 2021-09-23 18:32 ` Eduardo Habkost @ 2021-09-23 18:45 ` John Snow 0 siblings, 0 replies; 6+ messages in thread From: John Snow @ 2021-09-23 18:45 UTC (permalink / raw) To: Eduardo Habkost Cc: Peter Maydell, Thomas Huth, Darren Kenny, Juan Quintela, Alex Bennée, qemu-devel, Dr. David Alan Gilbert, Alexander Bulekov, Bandan Das, Qiuhao Li, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster [-- Attachment #1: Type: text/plain, Size: 2897 bytes --] On Thu, Sep 23, 2021 at 2:33 PM Eduardo Habkost <ehabkost@redhat.com> wrote: > On Thu, Sep 23, 2021 at 02:22:03PM -0400, John Snow wrote: > > 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> > > Clear demonstration of the usefulness of patch 2/2 (these > occurrences of `foo` wouldn't have been added if the default role > was "any" because "any" errors out on invalid references). > > However, it looks like there are unrelated changes: > > [...] > > diff --git a/docs/devel/migration.rst b/docs/devel/migration.rst > > index 24012534827..6b1230f2d7f 100644 > > --- a/docs/devel/migration.rst > > +++ b/docs/devel/migration.rst > > @@ -403,8 +403,8 @@ version_id. And the function ``load_state_old()`` > (if present) is able to > > load state from minimum_version_id_old to minimum_version_id. This > > function is deprecated and will be removed when no more users are left. > > > > -There are *_V* forms of many ``VMSTATE_`` macros to load fields for > version dependent fields, > > -e.g. > > +There are *_V* forms of many ``VMSTATE_`` macros to load fields for > > +version dependent fields, e.g. > > Unrelated? Line wrapping change only. > > > > > .. code:: c > > > > @@ -819,9 +819,9 @@ Postcopy now works with hugetlbfs backed memory: > > Postcopy with shared memory > > --------------------------- > > > > -Postcopy migration with shared memory needs explicit support from the > other > > -processes that share memory and from QEMU. There are restrictions on > the type of > > -memory that userfault can support shared. > > +Postcopy migration with shared memory needs explicit support from the > > +other processes that share memory and from QEMU. There are restrictions > > +on the type of memory that userfault can support shared. > > Unrelated? Line wrapping change only. > > Reviewed-by: Eduardo Habkost <ehabkost@redhat.com> # if unrelated line > wrapping changes are dropped > > -- > Eduardo > > Apologies for that -- it's bad rebase confetti. Something got merged automatically and it resulted in weird junk. Sorry for the noise. --js [-- Attachment #2: Type: text/html, Size: 3790 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2 2/2] docs/sphinx: change default role to "any" 2021-09-23 18:22 [PATCH v2 0/2] docs/sphinx: change default `role` to "any" John Snow 2021-09-23 18:22 ` [PATCH v2 1/2] docs: remove non-reference uses of single backticks John Snow @ 2021-09-23 18:22 ` John Snow 1 sibling, 0 replies; 6+ messages in thread From: John Snow @ 2021-09-23 18:22 UTC (permalink / raw) To: qemu-devel Cc: Peter Maydell, Thomas Huth, Eduardo Habkost, Darren Kenny, Juan Quintela, Alex Bennée, Dr. David Alan Gilbert, Qiuhao Li, John Snow, Alexander Bulekov, Bandan Das, Stefan Hajnoczi, Paolo Bonzini, Alexandre Iooss, Mahmoud Mandour, Eric Blake, Markus Armbruster 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 `backticks` will cause a build failure if the target cannot be referenced. Signed-off-by: John Snow <jsnow@redhat.com> --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2e..4d9f56601fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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' -- 2.31.1 ^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-09-23 18:47 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2021-09-23 18:22 [PATCH v2 0/2] docs/sphinx: change default `role` to "any" John Snow 2021-09-23 18:22 ` [PATCH v2 1/2] docs: remove non-reference uses of single backticks John Snow 2021-09-23 18:31 ` Peter Maydell 2021-09-23 18:32 ` Eduardo Habkost 2021-09-23 18:45 ` John Snow 2021-09-23 18:22 ` [PATCH v2 2/2] docs/sphinx: change default role to "any" John Snow
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).