On Thu, 23 Sept 2021 at 19:22, John Snow <js...@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 <js...@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
