Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks
On Thu, Sep 23, 2021 at 2:33 PM Eduardo Habkost 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 > > 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 # 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
Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks
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 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 # if unrelated line wrapping changes are dropped -- Eduardo
Re: [PATCH v2 1/2] docs: remove non-reference uses of single backticks
On Thu, 23 Sept 2021 at 19:22, 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 > 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
[PATCH v2 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. Signed-off-by: John Snow --- 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..8b187f8 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 @@
