* [PATCH 01/29] configure: Allow user to specify sphinx-build binary
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 02/29] configure: Check that sphinx-build is using Python 3 Peter Maydell
` (32 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Currently we insist on using 'sphinx-build' from the $PATH;
allow the user to specify the binary to use. This will be
more useful as we become pickier about the capabilities
we require (eg needing a Python 3 sphinx-build).
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
---
configure | 10 +++++++++-
Makefile | 2 +-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index 115dc38085f..0aceb8e50db 100755
--- a/configure
+++ b/configure
@@ -584,6 +584,7 @@ query_pkg_config() {
}
pkg_config=query_pkg_config
sdl2_config="${SDL2_CONFIG-${cross_prefix}sdl2-config}"
+sphinx_build=sphinx-build
# If the user hasn't specified ARFLAGS, default to 'rv', just as make does.
ARFLAGS="${ARFLAGS-rv}"
@@ -975,6 +976,8 @@ for opt do
;;
--python=*) python="$optarg"
;;
+ --sphinx-build=*) sphinx_build="$optarg"
+ ;;
--gcov=*) gcov_tool="$optarg"
;;
--smbd=*) smbd="$optarg"
@@ -1677,6 +1680,7 @@ Advanced options (experts only):
--make=MAKE use specified make [$make]
--install=INSTALL use specified install [$install]
--python=PYTHON use specified python [$python]
+ --sphinx-build=SPHINX use specified sphinx-build [$sphinx_build]
--smbd=SMBD use specified smbd [$smbd]
--with-git=GIT use specified git [$git]
--static enable static build [$static]
@@ -4799,7 +4803,7 @@ has_sphinx_build() {
# sphinx-build doesn't exist at all or if it is too old.
mkdir -p "$TMPDIR1/sphinx"
touch "$TMPDIR1/sphinx/index.rst"
- sphinx-build -c "$source_path/docs" -b html "$TMPDIR1/sphinx" "$TMPDIR1/sphinx/out" >/dev/null 2>&1
+ $sphinx_build -c "$source_path/docs" -b html "$TMPDIR1/sphinx" "$TMPDIR1/sphinx/out" >/dev/null 2>&1
}
# Check if tools are available to build documentation.
@@ -6474,6 +6478,9 @@ echo "QEMU_LDFLAGS $QEMU_LDFLAGS"
echo "make $make"
echo "install $install"
echo "python $python ($python_version)"
+if test "$docs" != "no"; then
+ echo "sphinx-build $sphinx_build"
+fi
echo "slirp support $slirp $(echo_version $slirp $slirp_version)"
if test "$slirp" != "no" ; then
echo "smbd $smbd"
@@ -7503,6 +7510,7 @@ echo "INSTALL_DATA=$install -c -m 0644" >> $config_host_mak
echo "INSTALL_PROG=$install -c -m 0755" >> $config_host_mak
echo "INSTALL_LIB=$install -c -m 0644" >> $config_host_mak
echo "PYTHON=$python" >> $config_host_mak
+echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak
echo "CC=$cc" >> $config_host_mak
if $iasl -h > /dev/null 2>&1; then
echo "IASL=$iasl" >> $config_host_mak
diff --git a/Makefile b/Makefile
index 461d40bea6c..20bf0cc771a 100644
--- a/Makefile
+++ b/Makefile
@@ -1024,7 +1024,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
# Note the use of different doctree for each (manual, builder) tuple;
# this works around Sphinx not handling parallel invocation on
# a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946
-build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
+build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD) $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
# We assume all RST files in the manual's directory are used in it
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \
$(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 02/29] configure: Check that sphinx-build is using Python 3
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-02-06 17:30 ` [PATCH 01/29] configure: Allow user to specify sphinx-build binary Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 16:17 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 03/29] Makefile: Fix typo in dependency list for interop manpages Peter Maydell
` (31 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Currently configure's has_sphinx_build() check simply runs a dummy
sphinx-build and either passes or fails. This means that "no
sphinx-build at all" and "sphinx-build exists but is too old" are
both reported the same way.
Further, we want to assume that all the Python we write is running
with at least Python 3.5; configure checks that for our scripts, but
Sphinx extensions run with whatever Python version sphinx-build
itself is using.
Add a check to our conf.py which makes sphinx-build fail if it would
be running our extensions with an old Python, and handle this
in configure so we can report failure helpfully to the user.
This will mean that configure --enable-docs will fail like this
if the sphinx-build provided is not suitable:
Warning: sphinx-build exists but it is either too old or uses too old a Python version
ERROR: User requested feature docs
configure was not able to find it.
Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx
(As usual, the default is to simply not build the docs, as we would
if sphinx-build wasn't present at all.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
---
configure | 12 ++++++++++--
docs/conf.py | 10 ++++++++++
2 files changed, 20 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index 0aceb8e50db..2c5cad13edd 100755
--- a/configure
+++ b/configure
@@ -4808,11 +4808,19 @@ has_sphinx_build() {
# Check if tools are available to build documentation.
if test "$docs" != "no" ; then
- if has makeinfo && has pod2man && has_sphinx_build; then
+ if has_sphinx_build; then
+ sphinx_ok=yes
+ else
+ sphinx_ok=no
+ fi
+ if has makeinfo && has pod2man && test "$sphinx_ok" = "yes"; then
docs=yes
else
if test "$docs" = "yes" ; then
- feature_not_found "docs" "Install texinfo, Perl/perl-podlators and python-sphinx"
+ if has $sphinx_build && test "$sphinx_ok" != "yes"; then
+ echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2
+ fi
+ feature_not_found "docs" "Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx"
fi
docs=no
fi
diff --git a/docs/conf.py b/docs/conf.py
index ee7faa6b4e7..7588bf192ee 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -28,6 +28,16 @@
import os
import sys
+import sphinx
+from sphinx.errors import VersionRequirementError
+
+# Make Sphinx fail cleanly if using an old Python, rather than obscurely
+# failing because some code in one of our extensions doesn't work there.
+# Unfortunately this doesn't display very neatly (there's an unavoidable
+# Python backtrace) but at least the information gets printed...
+if sys.version_info < (3,5):
+ raise VersionRequirementError(
+ "QEMU requires a Sphinx that uses Python 3.5 or better\n")
# The per-manual conf.py will set qemu_docdir for a single-manual build;
# otherwise set it here if this is an entire-manual-set build.
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 02/29] configure: Check that sphinx-build is using Python 3
2020-02-06 17:30 ` [PATCH 02/29] configure: Check that sphinx-build is using Python 3 Peter Maydell
@ 2020-02-07 16:17 ` Markus Armbruster
2020-02-07 16:30 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 16:17 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> Currently configure's has_sphinx_build() check simply runs a dummy
> sphinx-build and either passes or fails. This means that "no
> sphinx-build at all" and "sphinx-build exists but is too old" are
> both reported the same way.
>
> Further, we want to assume that all the Python we write is running
> with at least Python 3.5; configure checks that for our scripts, but
> Sphinx extensions run with whatever Python version sphinx-build
> itself is using.
>
> Add a check to our conf.py which makes sphinx-build fail if it would
> be running our extensions with an old Python, and handle this
> in configure so we can report failure helpfully to the user.
> This will mean that configure --enable-docs will fail like this
> if the sphinx-build provided is not suitable:
>
> Warning: sphinx-build exists but it is either too old or uses too old a Python version
>
> ERROR: User requested feature docs
> configure was not able to find it.
> Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx
>
> (As usual, the default is to simply not build the docs, as we would
> if sphinx-build wasn't present at all.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
> ---
> configure | 12 ++++++++++--
> docs/conf.py | 10 ++++++++++
> 2 files changed, 20 insertions(+), 2 deletions(-)
>
> diff --git a/configure b/configure
> index 0aceb8e50db..2c5cad13edd 100755
> --- a/configure
> +++ b/configure
Any particular reason for having $sphinx_build default to the
indeterminate version sphinx-build rather than sphinx-build-3?
It's here:
pkg_config=query_pkg_config
sdl2_config="${SDL2_CONFIG-${cross_prefix}sdl2-config}"
sphinx_build=sphinx-build
# If the user hasn't specified ARFLAGS, default to 'rv', just as make does.
ARFLAGS="${ARFLAGS-rv}"
> @@ -4808,11 +4808,19 @@ has_sphinx_build() {
>
> # Check if tools are available to build documentation.
> if test "$docs" != "no" ; then
> - if has makeinfo && has pod2man && has_sphinx_build; then
> + if has_sphinx_build; then
> + sphinx_ok=yes
> + else
> + sphinx_ok=no
> + fi
> + if has makeinfo && has pod2man && test "$sphinx_ok" = "yes"; then
> docs=yes
> else
> if test "$docs" = "yes" ; then
> - feature_not_found "docs" "Install texinfo, Perl/perl-podlators and python-sphinx"
> + if has $sphinx_build && test "$sphinx_ok" != "yes"; then
> + echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2
> + fi
> + feature_not_found "docs" "Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx"
> fi
> docs=no
> fi
> diff --git a/docs/conf.py b/docs/conf.py
> index ee7faa6b4e7..7588bf192ee 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -28,6 +28,16 @@
>
> import os
> import sys
> +import sphinx
> +from sphinx.errors import VersionRequirementError
> +
> +# Make Sphinx fail cleanly if using an old Python, rather than obscurely
> +# failing because some code in one of our extensions doesn't work there.
> +# Unfortunately this doesn't display very neatly (there's an unavoidable
> +# Python backtrace) but at least the information gets printed...
> +if sys.version_info < (3,5):
> + raise VersionRequirementError(
> + "QEMU requires a Sphinx that uses Python 3.5 or better\n")
>
> # The per-manual conf.py will set qemu_docdir for a single-manual build;
> # otherwise set it here if this is an entire-manual-set build.
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 02/29] configure: Check that sphinx-build is using Python 3
2020-02-07 16:17 ` Markus Armbruster
@ 2020-02-07 16:30 ` Peter Maydell
2020-02-08 7:50 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 16:30 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 16:18, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > Currently configure's has_sphinx_build() check simply runs a dummy
> > sphinx-build and either passes or fails. This means that "no
> > sphinx-build at all" and "sphinx-build exists but is too old" are
> > both reported the same way.
> >
> > Further, we want to assume that all the Python we write is running
> > with at least Python 3.5; configure checks that for our scripts, but
> > Sphinx extensions run with whatever Python version sphinx-build
> > itself is using.
> >
> > Add a check to our conf.py which makes sphinx-build fail if it would
> > be running our extensions with an old Python, and handle this
> > in configure so we can report failure helpfully to the user.
> > This will mean that configure --enable-docs will fail like this
> > if the sphinx-build provided is not suitable:
> >
> > Warning: sphinx-build exists but it is either too old or uses too old a Python version
> >
> > ERROR: User requested feature docs
> > configure was not able to find it.
> > Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx
> >
> > (As usual, the default is to simply not build the docs, as we would
> > if sphinx-build wasn't present at all.)
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> > Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> > Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
> > ---
> > configure | 12 ++++++++++--
> > docs/conf.py | 10 ++++++++++
> > 2 files changed, 20 insertions(+), 2 deletions(-)
> >
> > diff --git a/configure b/configure
> > index 0aceb8e50db..2c5cad13edd 100755
> > --- a/configure
> > +++ b/configure
>
> Any particular reason for having $sphinx_build default to the
> indeterminate version sphinx-build rather than sphinx-build-3?
Because that's the binary we were using before this patch.
"Allow the user to specify" shouldn't be tangled up with
"and also change the default".
It might be sphinx-build-3 on RH, but on Debian/Ubuntu it's
just 'sphinx-build' assuming you installed the python3-sphinx
and not the python2-sphinx, or you can run it directly out of
/usr/share/sphinx/scripts/python3/sphinx-build, or (like
me) you might have a locally installed 'sphinx-build' which
is using Python 3. My assumption is that once the python2->3
transition has faded into the rear view mirror most distros
will just have a /usr/bin/sphinx-build that's a Python 3 one.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 02/29] configure: Check that sphinx-build is using Python 3
2020-02-07 16:30 ` Peter Maydell
@ 2020-02-08 7:50 ` Markus Armbruster
2020-02-08 13:11 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-08 7:50 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 16:18, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > Currently configure's has_sphinx_build() check simply runs a dummy
>> > sphinx-build and either passes or fails. This means that "no
>> > sphinx-build at all" and "sphinx-build exists but is too old" are
>> > both reported the same way.
>> >
>> > Further, we want to assume that all the Python we write is running
>> > with at least Python 3.5; configure checks that for our scripts, but
>> > Sphinx extensions run with whatever Python version sphinx-build
>> > itself is using.
>> >
>> > Add a check to our conf.py which makes sphinx-build fail if it would
>> > be running our extensions with an old Python, and handle this
>> > in configure so we can report failure helpfully to the user.
>> > This will mean that configure --enable-docs will fail like this
>> > if the sphinx-build provided is not suitable:
>> >
>> > Warning: sphinx-build exists but it is either too old or uses too old a Python version
>> >
>> > ERROR: User requested feature docs
>> > configure was not able to find it.
>> > Install texinfo, Perl/perl-podlators and a Python 3 version of python-sphinx
>> >
>> > (As usual, the default is to simply not build the docs, as we would
>> > if sphinx-build wasn't present at all.)
>> >
>> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>> > Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
>> > Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
>> > ---
>> > configure | 12 ++++++++++--
>> > docs/conf.py | 10 ++++++++++
>> > 2 files changed, 20 insertions(+), 2 deletions(-)
>> >
>> > diff --git a/configure b/configure
>> > index 0aceb8e50db..2c5cad13edd 100755
>> > --- a/configure
>> > +++ b/configure
>>
>> Any particular reason for having $sphinx_build default to the
>> indeterminate version sphinx-build rather than sphinx-build-3?
>
> Because that's the binary we were using before this patch.
> "Allow the user to specify" shouldn't be tangled up with
> "and also change the default".
>
> It might be sphinx-build-3 on RH, but on Debian/Ubuntu it's
> just 'sphinx-build' assuming you installed the python3-sphinx
> and not the python2-sphinx, or you can run it directly out of
> /usr/share/sphinx/scripts/python3/sphinx-build, or (like
> me) you might have a locally installed 'sphinx-build' which
> is using Python 3. My assumption is that once the python2->3
> transition has faded into the rear view mirror most distros
> will just have a /usr/bin/sphinx-build that's a Python 3 one.
Defaulting to sphinx-build-3 if it exists, else sphinx-build would be
nicer for users on some common systems, and wouldn't hurt users on the
other common systems. It's what we do for Python.
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 02/29] configure: Check that sphinx-build is using Python 3
2020-02-08 7:50 ` Markus Armbruster
@ 2020-02-08 13:11 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-08 13:11 UTC (permalink / raw)
To: Markus Armbruster
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
On Sat, 8 Feb 2020 at 07:51, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
> > It might be sphinx-build-3 on RH, but on Debian/Ubuntu it's
> > just 'sphinx-build' assuming you installed the python3-sphinx
> > and not the python2-sphinx, or you can run it directly out of
> > /usr/share/sphinx/scripts/python3/sphinx-build, or (like
> > me) you might have a locally installed 'sphinx-build' which
> > is using Python 3. My assumption is that once the python2->3
> > transition has faded into the rear view mirror most distros
> > will just have a /usr/bin/sphinx-build that's a Python 3 one.
>
> Defaulting to sphinx-build-3 if it exists, else sphinx-build would be
> nicer for users on some common systems, and wouldn't hurt users on the
> other common systems. It's what we do for Python.
Feel free to send a followup patch :-) I have no systems where
there is a 'sphinx-build-3' at all.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 03/29] Makefile: Fix typo in dependency list for interop manpages
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-02-06 17:30 ` [PATCH 01/29] configure: Allow user to specify sphinx-build binary Peter Maydell
2020-02-06 17:30 ` [PATCH 02/29] configure: Check that sphinx-build is using Python 3 Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 04/29] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Peter Maydell
` (30 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Fix a typo in the dependency list for the manpages built from the
'interop' manual, which meant we were accidentally not including
the .hx file in the dependency list.
Fixes: e13c59fa4414215500e6
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
Makefile | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 20bf0cc771a..274a24f7aa4 100644
--- a/Makefile
+++ b/Makefile
@@ -1052,7 +1052,7 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
$(call define-manpage-rule,interop,\
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1 virtfs-proxy-helper.1,\
- $(SRC_PATH/qemu-img-cmds.hx))
+ $(SRC_PATH)/qemu-img-cmds.hx)
$(call define-manpage-rule,system,qemu-block-drivers.7)
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 04/29] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (2 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 03/29] Makefile: Fix typo in dependency list for interop manpages Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 8:16 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments Peter Maydell
` (29 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
The doc comment for GuestDiskBusType doesn't match up with the
enumeration because of a missing hyphen in 'file-backed-virtual'.
This means the docs are rendered wrongly:
"virtual"
Win virtual bus type "file-backed" virtual: Win file-backed bus type
"file-backed-virtual"
Not documented
Add the missing hyphen.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
qga/qapi-schema.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index fb4605cc19c..23ce6af597d 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -809,7 +809,7 @@
# @sas: Win serial-attaches SCSI bus type
# @mmc: Win multimedia card (MMC) bus type
# @virtual: Win virtual bus type
-# @file-backed virtual: Win file-backed bus type
+# @file-backed-virtual: Win file-backed bus type
#
# Since: 2.2; 'Unknown' and all entries below since 2.4
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 04/29] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment
2020-02-06 17:30 ` [PATCH 04/29] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Peter Maydell
@ 2020-02-07 8:16 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 8:16 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> The doc comment for GuestDiskBusType doesn't match up with the
> enumeration because of a missing hyphen in 'file-backed-virtual'.
> This means the docs are rendered wrongly:
> "virtual"
> Win virtual bus type "file-backed" virtual: Win file-backed bus type
I expected a funny rendering, but not this one. The doc generator is
full of surprises...
>
> "file-backed-virtual"
> Not documented
> Add the missing hyphen.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> Reviewed-by: Eric Blake <eblake@redhat.com>
> ---
> qga/qapi-schema.json | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index fb4605cc19c..23ce6af597d 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -809,7 +809,7 @@
> # @sas: Win serial-attaches SCSI bus type
> # @mmc: Win multimedia card (MMC) bus type
> # @virtual: Win virtual bus type
> -# @file-backed virtual: Win file-backed bus type
> +# @file-backed-virtual: Win file-backed bus type
> #
> # Since: 2.2; 'Unknown' and all entries below since 2.4
> ##
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (3 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 04/29] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 8:18 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST Peter Maydell
` (28 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
The texinfo doc generation doesn't care much about indentation
levels, but we would like to add a rST backend, and rST does care
about indentation.
Make the doc comments more strongly consistent about indentation
for multiline constructs like:
@arg: description line 1
description line 2
Returns: line one
line 2
so that there is always exactly one space after the colon, and
subsequent lines align with the first.
This commit is a purely whitespace change, and it does not alter the
generated .texi files (because the texi generation code strips away
all the extra whitespace). This does mean that we end up with some
over-length lines.
Note that when the documentation for an argument fits on a single
line like this:
@arg: one line only
then stray extra spaces after the ':' don't affect the rST output, so
I have not attempted to methodically fix them, though the preference
is a single space here too.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qga/qapi-schema.json | 62 ++++++++++++++++++++++----------------------
1 file changed, 31 insertions(+), 31 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 23ce6af597d..7661b2b3b45 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -416,7 +416,7 @@
# Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined below)
#
# Note: This may fail to properly report the current state as a result of
-# some other guest processes having issued an fs freeze/thaw.
+# some other guest processes having issued an fs freeze/thaw.
#
# Since: 0.15.0
##
@@ -431,13 +431,13 @@
# unfreeze.
#
# Note: On Windows, the command is implemented with the help of a
-# Volume Shadow-copy Service DLL helper. The frozen state is limited
-# for up to 10 seconds by VSS.
+# Volume Shadow-copy Service DLL helper. The frozen state is limited
+# for up to 10 seconds by VSS.
#
# Returns: Number of file systems currently frozen. On error, all filesystems
-# will be thawed. If no filesystems are frozen as a result of this call,
-# then @guest-fsfreeze-status will remain "thawed" and calling
-# @guest-fsfreeze-thaw is not necessary.
+# will be thawed. If no filesystems are frozen as a result of this call,
+# then @guest-fsfreeze-status will remain "thawed" and calling
+# @guest-fsfreeze-thaw is not necessary.
#
# Since: 0.15.0
##
@@ -455,7 +455,7 @@
# Invalid mount points are ignored.
#
# Returns: Number of file systems currently frozen. On error, all filesystems
-# will be thawed.
+# will be thawed.
#
# Since: 2.2
##
@@ -511,12 +511,12 @@
# Discard (or "trim") blocks which are not in use by the filesystem.
#
# @minimum:
-# Minimum contiguous free range to discard, in bytes. Free ranges
-# smaller than this may be ignored (this is a hint and the guest
-# may not respect it). By increasing this value, the fstrim
-# operation will complete more quickly for filesystems with badly
-# fragmented free space, although not all blocks will be discarded.
-# The default value is zero, meaning "discard every free block".
+# Minimum contiguous free range to discard, in bytes. Free ranges
+# smaller than this may be ignored (this is a hint and the guest
+# may not respect it). By increasing this value, the fstrim
+# operation will complete more quickly for filesystems with badly
+# fragmented free space, although not all blocks will be discarded.
+# The default value is zero, meaning "discard every free block".
#
# Returns: A @GuestFilesystemTrimResponse which contains the
# status of all trimmed paths. (since 2.4)
@@ -693,7 +693,7 @@
# @ip-addresses: List of addresses assigned to @name
#
# @statistics: various statistic counters related to @name
-# (since 2.11)
+# (since 2.11)
#
# Since: 1.1
##
@@ -743,7 +743,7 @@
# This is a read-only operation.
#
# Returns: The list of all VCPUs the guest knows about. Each VCPU is put on the
-# list exactly once, but their order is unspecified.
+# list exactly once, but their order is unspecified.
#
# Since: 1.5
##
@@ -937,8 +937,8 @@
# This is a read-only operation.
#
# Returns: The list of all memory blocks the guest knows about.
-# Each memory block is put on the list exactly once, but their order
-# is unspecified.
+# Each memory block is put on the list exactly once, but their order
+# is unspecified.
#
# Since: 2.3
##
@@ -971,9 +971,9 @@
# @response: the result of memory block operation.
#
# @error-code: the error number.
-# When memory block operation fails, we assign the value of
-# 'errno' to this member, it indicates what goes wrong.
-# When the operation succeeds, it will be omitted.
+# When memory block operation fails, we assign the value of
+# 'errno' to this member, it indicates what goes wrong.
+# When the operation succeeds, it will be omitted.
#
# Since: 2.3
##
@@ -1040,15 +1040,15 @@
# @exited: true if process has already terminated.
# @exitcode: process exit code if it was normally terminated.
# @signal: signal number (linux) or unhandled exception code
-# (windows) if the process was abnormally terminated.
+# (windows) if the process was abnormally terminated.
# @out-data: base64-encoded stdout of the process
# @err-data: base64-encoded stderr of the process
-# Note: @out-data and @err-data are present only
-# if 'capture-output' was specified for 'guest-exec'
+# Note: @out-data and @err-data are present only
+# if 'capture-output' was specified for 'guest-exec'
# @out-truncated: true if stdout was not fully captured
-# due to size limitation.
+# due to size limitation.
# @err-truncated: true if stderr was not fully captured
-# due to size limitation.
+# due to size limitation.
#
# Since: 2.5
##
@@ -1131,8 +1131,8 @@
##
# @GuestUser:
-# @user: Username
-# @domain: Logon domain (windows only)
+# @user: Username
+# @domain: Logon domain (windows only)
# @login-time: Time of login of this user on the computer. If multiple
# instances of the user are logged in, the earliest login time is
# reported. The value is in fractional seconds since epoch time.
@@ -1156,10 +1156,10 @@
##
# @GuestTimezone:
#
-# @zone: Timezone name. These values may differ depending on guest/OS and
-# should only be used for informational purposes.
-# @offset: Offset to UTC in seconds, negative numbers for time zones west of
-# GMT, positive numbers for east
+# @zone: Timezone name. These values may differ depending on guest/OS and
+# should only be used for informational purposes.
+# @offset: Offset to UTC in seconds, negative numbers for time zones west of
+# GMT, positive numbers for east
#
# Since: 2.10
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments
2020-02-06 17:30 ` [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments Peter Maydell
@ 2020-02-07 8:18 ` Markus Armbruster
2020-02-07 8:22 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 8:18 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> The texinfo doc generation doesn't care much about indentation
> levels, but we would like to add a rST backend, and rST does care
> about indentation.
>
> Make the doc comments more strongly consistent about indentation
> for multiline constructs like:
>
> @arg: description line 1
> description line 2
>
> Returns: line one
> line 2
>
> so that there is always exactly one space after the colon, and
> subsequent lines align with the first.
>
> This commit is a purely whitespace change, and it does not alter the
> generated .texi files (because the texi generation code strips away
> all the extra whitespace). This does mean that we end up with some
> over-length lines.
>
> Note that when the documentation for an argument fits on a single
> line like this:
>
> @arg: one line only
>
> then stray extra spaces after the ':' don't affect the rST output, so
> I have not attempted to methodically fix them, though the preference
> is a single space here too.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
How is this commit related to PATCH 9? The commit messages are
suspiciously similar...
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments
2020-02-07 8:18 ` Markus Armbruster
@ 2020-02-07 8:22 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 8:22 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Markus Armbruster <armbru@redhat.com> writes:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> The texinfo doc generation doesn't care much about indentation
>> levels, but we would like to add a rST backend, and rST does care
>> about indentation.
>>
>> Make the doc comments more strongly consistent about indentation
>> for multiline constructs like:
>>
>> @arg: description line 1
>> description line 2
>>
>> Returns: line one
>> line 2
>>
>> so that there is always exactly one space after the colon, and
>> subsequent lines align with the first.
>>
>> This commit is a purely whitespace change, and it does not alter the
>> generated .texi files (because the texi generation code strips away
>> all the extra whitespace). This does mean that we end up with some
>> over-length lines.
>>
>> Note that when the documentation for an argument fits on a single
>> line like this:
>>
>> @arg: one line only
>>
>> then stray extra spaces after the ':' don't affect the rST output, so
>> I have not attempted to methodically fix them, though the preference
>> is a single space here too.
>>
>> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>
> How is this commit related to PATCH 9? The commit messages are
> suspiciously similar...
Nevermind, I got it: this one's for qga/, PATCH 9 if for qapi/.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (4 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 05/29] qga/qapi-schema.json: Fix indent level on doc comments Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 8:32 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art Peter Maydell
` (27 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
rST format requires a blank line before the start of a bulleted
or enumerated list. Two places in qapi-schema.json were missing
this blank line.
Some places were using an indented line as a sort of single-item
bulleted list, which in the texinfo output comes out all run
onto a single line; use a real bulleted list instead.
Some places unnecessarily indented lists, which confuses rST.
guest-fstrim:minimum's documentation was indented the
right amount to share a line with @minimum, but wasn't
actually doing so.
The indent on the bulleted list in the guest-set-vcpus
Returns section meant rST misindented it.
Changes to the generated texinfo are very minor (the new
bulletted lists, and a few extra blank lines).
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qga/qapi-schema.json | 86 +++++++++++++++++++++++---------------------
1 file changed, 45 insertions(+), 41 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 7661b2b3b45..0e3a00ee052 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -510,8 +510,7 @@
#
# Discard (or "trim") blocks which are not in use by the filesystem.
#
-# @minimum:
-# Minimum contiguous free range to discard, in bytes. Free ranges
+# @minimum: Minimum contiguous free range to discard, in bytes. Free ranges
# smaller than this may be ignored (this is a hint and the guest
# may not respect it). By increasing this value, the fstrim
# operation will complete more quickly for filesystems with badly
@@ -546,7 +545,8 @@
# (or set its status to "shutdown") due to other reasons.
#
# The following errors may be returned:
-# If suspend to disk is not supported, Unsupported
+#
+# - If suspend to disk is not supported, Unsupported
#
# Notes: It's strongly recommended to issue the guest-sync command before
# sending commands when the guest resumes
@@ -575,12 +575,14 @@
#
# This command does NOT return a response on success. There are two options
# to check for success:
-# 1. Wait for the SUSPEND QMP event from QEMU
-# 2. Issue the query-status QMP command to confirm the VM status is
-# "suspended"
+#
+# 1. Wait for the SUSPEND QMP event from QEMU
+# 2. Issue the query-status QMP command to confirm the VM status is
+# "suspended"
#
# The following errors may be returned:
-# If suspend to ram is not supported, Unsupported
+#
+# - If suspend to ram is not supported, Unsupported
#
# Notes: It's strongly recommended to issue the guest-sync command before
# sending commands when the guest resumes
@@ -607,12 +609,14 @@
#
# This command does NOT return a response on success. There are two options
# to check for success:
-# 1. Wait for the SUSPEND QMP event from QEMU
-# 2. Issue the query-status QMP command to confirm the VM status is
-# "suspended"
+#
+# 1. Wait for the SUSPEND QMP event from QEMU
+# 2. Issue the query-status QMP command to confirm the VM status is
+# "suspended"
#
# The following errors may be returned:
-# If hybrid suspend is not supported, Unsupported
+#
+# - If hybrid suspend is not supported, Unsupported
#
# Notes: It's strongly recommended to issue the guest-sync command before
# sending commands when the guest resumes
@@ -767,17 +771,17 @@
# Returns: The length of the initial sublist that has been successfully
# processed. The guest agent maximizes this value. Possible cases:
#
-# - 0: if the @vcpus list was empty on input. Guest state
-# has not been changed. Otherwise,
-# - Error: processing the first node of @vcpus failed for the
-# reason returned. Guest state has not been changed.
-# Otherwise,
+# - 0: if the @vcpus list was empty on input. Guest state
+# has not been changed. Otherwise,
+# - Error: processing the first node of @vcpus failed for the
+# reason returned. Guest state has not been changed.
+# Otherwise,
# - < length(@vcpus): more than zero initial nodes have been processed,
-# but not the entire @vcpus list. Guest state has
-# changed accordingly. To retrieve the error
-# (assuming it persists), repeat the call with the
-# successfully processed initial sublist removed.
-# Otherwise,
+# but not the entire @vcpus list. Guest state has
+# changed accordingly. To retrieve the error
+# (assuming it persists), repeat the call with the
+# successfully processed initial sublist removed.
+# Otherwise,
# - length(@vcpus): call successful.
#
# Since: 1.5
@@ -1182,35 +1186,35 @@
# @GuestOSInfo:
#
# @kernel-release:
-# * POSIX: release field returned by uname(2)
-# * Windows: build number of the OS
+# * POSIX: release field returned by uname(2)
+# * Windows: build number of the OS
# @kernel-version:
-# * POSIX: version field returned by uname(2)
-# * Windows: version number of the OS
+# * POSIX: version field returned by uname(2)
+# * Windows: version number of the OS
# @machine:
-# * POSIX: machine field returned by uname(2)
-# * Windows: one of x86, x86_64, arm, ia64
+# * POSIX: machine field returned by uname(2)
+# * Windows: one of x86, x86_64, arm, ia64
# @id:
-# * POSIX: as defined by os-release(5)
-# * Windows: contains string "mswindows"
+# * POSIX: as defined by os-release(5)
+# * Windows: contains string "mswindows"
# @name:
-# * POSIX: as defined by os-release(5)
-# * Windows: contains string "Microsoft Windows"
+# * POSIX: as defined by os-release(5)
+# * Windows: contains string "Microsoft Windows"
# @pretty-name:
-# * POSIX: as defined by os-release(5)
-# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise"
+# * POSIX: as defined by os-release(5)
+# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise"
# @version:
-# * POSIX: as defined by os-release(5)
-# * Windows: long version string, e.g. "Microsoft Windows Server 2008"
+# * POSIX: as defined by os-release(5)
+# * Windows: long version string, e.g. "Microsoft Windows Server 2008"
# @version-id:
-# * POSIX: as defined by os-release(5)
-# * Windows: short version identifier, e.g. "7" or "20012r2"
+# * POSIX: as defined by os-release(5)
+# * Windows: short version identifier, e.g. "7" or "20012r2"
# @variant:
-# * POSIX: as defined by os-release(5)
-# * Windows: contains string "server" or "client"
+# * POSIX: as defined by os-release(5)
+# * Windows: contains string "server" or "client"
# @variant-id:
-# * POSIX: as defined by os-release(5)
-# * Windows: contains string "server" or "client"
+# * POSIX: as defined by os-release(5)
+# * Windows: contains string "server" or "client"
#
# Notes:
#
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST
2020-02-06 17:30 ` [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST Peter Maydell
@ 2020-02-07 8:32 ` Markus Armbruster
2020-02-13 16:20 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 8:32 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> rST format requires a blank line before the start of a bulleted
> or enumerated list. Two places in qapi-schema.json were missing
> this blank line.
>
> Some places were using an indented line as a sort of single-item
> bulleted list, which in the texinfo output comes out all run
> onto a single line; use a real bulleted list instead.
>
> Some places unnecessarily indented lists, which confuses rST.
>
> guest-fstrim:minimum's documentation was indented the
> right amount to share a line with @minimum, but wasn't
> actually doing so.
>
> The indent on the bulleted list in the guest-set-vcpus
> Returns section meant rST misindented it.
>
> Changes to the generated texinfo are very minor (the new
> bulletted lists, and a few extra blank lines).
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qga/qapi-schema.json | 86 +++++++++++++++++++++++---------------------
> 1 file changed, 45 insertions(+), 41 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 7661b2b3b45..0e3a00ee052 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -510,8 +510,7 @@
> #
> # Discard (or "trim") blocks which are not in use by the filesystem.
> #
> -# @minimum:
> -# Minimum contiguous free range to discard, in bytes. Free ranges
> +# @minimum: Minimum contiguous free range to discard, in bytes. Free ranges
> # smaller than this may be ignored (this is a hint and the guest
> # may not respect it). By increasing this value, the fstrim
> # operation will complete more quickly for filesystems with badly
> @@ -546,7 +545,8 @@
> # (or set its status to "shutdown") due to other reasons.
> #
> # The following errors may be returned:
> -# If suspend to disk is not supported, Unsupported
> +#
> +# - If suspend to disk is not supported, Unsupported
> #
> # Notes: It's strongly recommended to issue the guest-sync command before
> # sending commands when the guest resumes
> @@ -575,12 +575,14 @@
> #
> # This command does NOT return a response on success. There are two options
> # to check for success:
> -# 1. Wait for the SUSPEND QMP event from QEMU
> -# 2. Issue the query-status QMP command to confirm the VM status is
> -# "suspended"
> +#
> +# 1. Wait for the SUSPEND QMP event from QEMU
> +# 2. Issue the query-status QMP command to confirm the VM status is
> +# "suspended"
> #
> # The following errors may be returned:
> -# If suspend to ram is not supported, Unsupported
> +#
> +# - If suspend to ram is not supported, Unsupported
> #
> # Notes: It's strongly recommended to issue the guest-sync command before
> # sending commands when the guest resumes
> @@ -607,12 +609,14 @@
> #
> # This command does NOT return a response on success. There are two options
> # to check for success:
> -# 1. Wait for the SUSPEND QMP event from QEMU
> -# 2. Issue the query-status QMP command to confirm the VM status is
> -# "suspended"
> +#
> +# 1. Wait for the SUSPEND QMP event from QEMU
> +# 2. Issue the query-status QMP command to confirm the VM status is
> +# "suspended"
> #
> # The following errors may be returned:
> -# If hybrid suspend is not supported, Unsupported
> +#
> +# - If hybrid suspend is not supported, Unsupported
> #
> # Notes: It's strongly recommended to issue the guest-sync command before
> # sending commands when the guest resumes
> @@ -767,17 +771,17 @@
> # Returns: The length of the initial sublist that has been successfully
> # processed. The guest agent maximizes this value. Possible cases:
> #
> -# - 0: if the @vcpus list was empty on input. Guest state
> -# has not been changed. Otherwise,
> -# - Error: processing the first node of @vcpus failed for the
> -# reason returned. Guest state has not been changed.
> -# Otherwise,
> +# - 0: if the @vcpus list was empty on input. Guest state
> +# has not been changed. Otherwise,
> +# - Error: processing the first node of @vcpus failed for the
> +# reason returned. Guest state has not been changed.
> +# Otherwise,
> # - < length(@vcpus): more than zero initial nodes have been processed,
> -# but not the entire @vcpus list. Guest state has
> -# changed accordingly. To retrieve the error
> -# (assuming it persists), repeat the call with the
> -# successfully processed initial sublist removed.
> -# Otherwise,
> +# but not the entire @vcpus list. Guest state has
> +# changed accordingly. To retrieve the error
> +# (assuming it persists), repeat the call with the
> +# successfully processed initial sublist removed.
> +# Otherwise,
> # - length(@vcpus): call successful.
Source readability suffers a bit here.
Can we break the line after the colon?
# - 0:
# if the @vcpus list was empty on input. Guest state has
# not been changed. Otherwise,
Or would a definition list be a better fit?
> #
> # Since: 1.5
> @@ -1182,35 +1186,35 @@
> # @GuestOSInfo:
> #
> # @kernel-release:
> -# * POSIX: release field returned by uname(2)
> -# * Windows: build number of the OS
> +# * POSIX: release field returned by uname(2)
> +# * Windows: build number of the OS
> # @kernel-version:
> -# * POSIX: version field returned by uname(2)
> -# * Windows: version number of the OS
> +# * POSIX: version field returned by uname(2)
> +# * Windows: version number of the OS
> # @machine:
> -# * POSIX: machine field returned by uname(2)
> -# * Windows: one of x86, x86_64, arm, ia64
> +# * POSIX: machine field returned by uname(2)
> +# * Windows: one of x86, x86_64, arm, ia64
> # @id:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: contains string "mswindows"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: contains string "mswindows"
> # @name:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: contains string "Microsoft Windows"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: contains string "Microsoft Windows"
> # @pretty-name:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise"
> # @version:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: long version string, e.g. "Microsoft Windows Server 2008"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: long version string, e.g. "Microsoft Windows Server 2008"
> # @version-id:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: short version identifier, e.g. "7" or "20012r2"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: short version identifier, e.g. "7" or "20012r2"
> # @variant:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: contains string "server" or "client"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: contains string "server" or "client"
> # @variant-id:
> -# * POSIX: as defined by os-release(5)
> -# * Windows: contains string "server" or "client"
> +# * POSIX: as defined by os-release(5)
> +# * Windows: contains string "server" or "client"
> #
> # Notes:
> #
The use of bullets vs. dashes for lists seems a bit random, but that's
not this patch's fault.
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST
2020-02-07 8:32 ` Markus Armbruster
@ 2020-02-13 16:20 ` Peter Maydell
2020-02-14 13:16 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-13 16:20 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 08:33, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > rST format requires a blank line before the start of a bulleted
> > or enumerated list. Two places in qapi-schema.json were missing
> > this blank line.
> >
> > Some places were using an indented line as a sort of single-item
> > bulleted list, which in the texinfo output comes out all run
> > onto a single line; use a real bulleted list instead.
> >
> > Some places unnecessarily indented lists, which confuses rST.
> >
> > guest-fstrim:minimum's documentation was indented the
> > right amount to share a line with @minimum, but wasn't
> > actually doing so.
> >
> > The indent on the bulleted list in the guest-set-vcpus
> > Returns section meant rST misindented it.
> >
> > Changes to the generated texinfo are very minor (the new
> > bulletted lists, and a few extra blank lines).
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> > @@ -767,17 +771,17 @@
> > # Returns: The length of the initial sublist that has been successfully
> > # processed. The guest agent maximizes this value. Possible cases:
> > #
> > -# - 0: if the @vcpus list was empty on input. Guest state
> > -# has not been changed. Otherwise,
> > -# - Error: processing the first node of @vcpus failed for the
> > -# reason returned. Guest state has not been changed.
> > -# Otherwise,
> > +# - 0: if the @vcpus list was empty on input. Guest state
> > +# has not been changed. Otherwise,
> > +# - Error: processing the first node of @vcpus failed for the
> > +# reason returned. Guest state has not been changed.
> > +# Otherwise,
> > # - < length(@vcpus): more than zero initial nodes have been processed,
> > -# but not the entire @vcpus list. Guest state has
> > -# changed accordingly. To retrieve the error
> > -# (assuming it persists), repeat the call with the
> > -# successfully processed initial sublist removed.
> > -# Otherwise,
> > +# but not the entire @vcpus list. Guest state has
> > +# changed accordingly. To retrieve the error
> > +# (assuming it persists), repeat the call with the
> > +# successfully processed initial sublist removed.
> > +# Otherwise,
> > # - length(@vcpus): call successful.
>
> Source readability suffers a bit here.
>
> Can we break the line after the colon?
>
> # - 0:
> # if the @vcpus list was empty on input. Guest state has
> # not been changed. Otherwise,
>
> Or would a definition list be a better fit?
A definition list does produce nicer rendering in the rST, but
it breaks the rendering in the texinfo (which interprets the
indent of a rST definition list as meaninglist and renders it
all as one long run-on paragraph). For the purposes of this
initial cleanup, I'll put in the newlines you suggest, which
have no effect on rendering output for either texinfo or rST.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST
2020-02-13 16:20 ` Peter Maydell
@ 2020-02-14 13:16 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-14 13:16 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
QEMU Developers, Michael Roth, Markus Armbruster,
Stefan Hajnoczi, John Snow
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 08:33, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > rST format requires a blank line before the start of a bulleted
>> > or enumerated list. Two places in qapi-schema.json were missing
>> > this blank line.
>> >
>> > Some places were using an indented line as a sort of single-item
>> > bulleted list, which in the texinfo output comes out all run
>> > onto a single line; use a real bulleted list instead.
>> >
>> > Some places unnecessarily indented lists, which confuses rST.
>> >
>> > guest-fstrim:minimum's documentation was indented the
>> > right amount to share a line with @minimum, but wasn't
>> > actually doing so.
>> >
>> > The indent on the bulleted list in the guest-set-vcpus
>> > Returns section meant rST misindented it.
>> >
>> > Changes to the generated texinfo are very minor (the new
>> > bulletted lists, and a few extra blank lines).
>> >
>> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>
>> > @@ -767,17 +771,17 @@
>> > # Returns: The length of the initial sublist that has been successfully
>> > # processed. The guest agent maximizes this value. Possible cases:
>> > #
>> > -# - 0: if the @vcpus list was empty on input. Guest state
>> > -# has not been changed. Otherwise,
>> > -# - Error: processing the first node of @vcpus failed for the
>> > -# reason returned. Guest state has not been changed.
>> > -# Otherwise,
>> > +# - 0: if the @vcpus list was empty on input. Guest state
>> > +# has not been changed. Otherwise,
>> > +# - Error: processing the first node of @vcpus failed for the
>> > +# reason returned. Guest state has not been changed.
>> > +# Otherwise,
>> > # - < length(@vcpus): more than zero initial nodes have been processed,
>> > -# but not the entire @vcpus list. Guest state has
>> > -# changed accordingly. To retrieve the error
>> > -# (assuming it persists), repeat the call with the
>> > -# successfully processed initial sublist removed.
>> > -# Otherwise,
>> > +# but not the entire @vcpus list. Guest state has
>> > +# changed accordingly. To retrieve the error
>> > +# (assuming it persists), repeat the call with the
>> > +# successfully processed initial sublist removed.
>> > +# Otherwise,
>> > # - length(@vcpus): call successful.
>>
>> Source readability suffers a bit here.
>>
>> Can we break the line after the colon?
>>
>> # - 0:
>> # if the @vcpus list was empty on input. Guest state has
>> # not been changed. Otherwise,
>>
>> Or would a definition list be a better fit?
>
> A definition list does produce nicer rendering in the rST, but
> it breaks the rendering in the texinfo (which interprets the
> indent of a rST definition list as meaninglist and renders it
> all as one long run-on paragraph). For the purposes of this
> initial cleanup, I'll put in the newlines you suggest, which
> have no effect on rendering output for either texinfo or rST.
Okay. We can switch to definition lists later.
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (5 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 06/29] qga/qapi-schema.json: minor format fixups for rST Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 8:50 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 08/29] qapi: Use ':' after @argument in doc comments Peter Maydell
` (26 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
The ascii-art graph in the BlockLatencyHistogramInfo
documentation doesn't render correctly in either the HTML
or the manpage output, because in both cases the whitespace
is collapsed.
Use the '|' format that emits a literal 'example' block
so the graph is displayed correctly.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index ef94a296868..372f35ee5f0 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -550,13 +550,13 @@
# For the example above, @bins may be something like [3, 1, 5, 2],
# and corresponding histogram looks like:
#
-# 5| *
-# 4| *
-# 3| * *
-# 2| * * *
-# 1| * * * *
-# +------------------
-# 10 50 100
+# | 5| *
+# | 4| *
+# | 3| * *
+# | 2| * * *
+# | 1| * * * *
+# | +------------------
+# | 10 50 100
#
# Since: 4.0
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art
2020-02-06 17:30 ` [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art Peter Maydell
@ 2020-02-07 8:50 ` Markus Armbruster
2020-02-07 9:27 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 8:50 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> The ascii-art graph in the BlockLatencyHistogramInfo
> documentation doesn't render correctly in either the HTML
> or the manpage output, because in both cases the whitespace
> is collapsed.
Plain text and PDF output is just as bad. Suggest "doesn't render
correctly, because the whitespace is collapsed".
> Use the '|' format that emits a literal 'example' block
> so the graph is displayed correctly.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/block-core.json | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index ef94a296868..372f35ee5f0 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -550,13 +550,13 @@
> # For the example above, @bins may be something like [3, 1, 5, 2],
> # and corresponding histogram looks like:
> #
> -# 5| *
> -# 4| *
> -# 3| * *
> -# 2| * * *
> -# 1| * * * *
> -# +------------------
> -# 10 50 100
> +# | 5| *
> +# | 4| *
> +# | 3| * *
> +# | 2| * * *
> +# | 1| * * * *
> +# | +------------------
> +# | 10 50 100
Wow, we're acquiring a second use of the '|' feature.
It's actually broken, because the doc generator puts each | line in its
own @example environment.
Doesn't really matter, because PATCH 26 replaces it by rST markup that
actually works. A note in the commit message could make sense, though.
But instead of making it differently broken until PATCH 26 fixes it for
good, I'd simply leave it broken until then :)
If you decide to keep the patch: can we keep the table aligned with the
preceding paragraph? Like this:
# | 5| *
# | 4| *
# | 3| * *
# | 2| * * *
# | 1| * * * *
# | +------------------
# | 10 50 100
> #
> # Since: 4.0
> ##
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art
2020-02-07 8:50 ` Markus Armbruster
@ 2020-02-07 9:27 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 9:27 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 08:50, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > The ascii-art graph in the BlockLatencyHistogramInfo
> > documentation doesn't render correctly in either the HTML
> > or the manpage output, because in both cases the whitespace
> > is collapsed.
>
> Plain text and PDF output is just as bad. Suggest "doesn't render
> correctly, because the whitespace is collapsed".
>
> > Use the '|' format that emits a literal 'example' block
> > so the graph is displayed correctly.
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> > ---
> > qapi/block-core.json | 14 +++++++-------
> > 1 file changed, 7 insertions(+), 7 deletions(-)
> >
> > diff --git a/qapi/block-core.json b/qapi/block-core.json
> > index ef94a296868..372f35ee5f0 100644
> > --- a/qapi/block-core.json
> > +++ b/qapi/block-core.json
> > @@ -550,13 +550,13 @@
> > # For the example above, @bins may be something like [3, 1, 5, 2],
> > # and corresponding histogram looks like:
> > #
> > -# 5| *
> > -# 4| *
> > -# 3| * *
> > -# 2| * * *
> > -# 1| * * * *
> > -# +------------------
> > -# 10 50 100
> > +# | 5| *
> > +# | 4| *
> > +# | 3| * *
> > +# | 2| * * *
> > +# | 1| * * * *
> > +# | +------------------
> > +# | 10 50 100
>
> Wow, we're acquiring a second use of the '|' feature.
>
> It's actually broken, because the doc generator puts each | line in its
> own @example environment.
>
> Doesn't really matter, because PATCH 26 replaces it by rST markup that
> actually works. A note in the commit message could make sense, though.
>
> But instead of making it differently broken until PATCH 26 fixes it for
> good, I'd simply leave it broken until then :)
IIRC I need to fix it early, because without the '|' prefix it's
a syntax error in rST because of the inconsistent indent. (Otherwise
I probably wouldn't have noticed it at all.)
> If you decide to keep the patch: can we keep the table aligned with the
> preceding paragraph? Like this:
>
> # | 5| *
> # | 4| *
> # | 3| * *
> # | 2| * * *
> # | 1| * * * *
> # | +------------------
> # | 10 50 100
>
> > #
> > # Since: 4.0
> > ##
Sure, why not.
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (6 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 07/29] qapi/block-core.json: Use literal block for ascii art Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 9:28 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 09/29] qapi: Fix indent level on doc comments in json files Peter Maydell
` (25 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Some qapi doc comments have forgotten the ':' after the
@argument, like this:
# @filename Filename for the new image file
# @size Size of the virtual disk in bytes
The result is that these are parsed as part of the body
text and appear as a run-on line:
filename Filename for the new image file size Size of the virtual disk in bytes"
followed by
filename: string
Not documented
size: int
Not documented
in the 'Members' section.
Correct the formatting.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 236 +++++++++++++++++++++----------------------
1 file changed, 118 insertions(+), 118 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 372f35ee5f0..076a4a4808e 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3235,9 +3235,9 @@
##
# @SshHostKeyCheckMode:
#
-# @none Don't check the host key at all
-# @hash Compare the host key with a given hash
-# @known_hosts Check the host key against the known_hosts file
+# @none: Don't check the host key at all
+# @hash: Compare the host key with a given hash
+# @known_hosts: Check the host key against the known_hosts file
#
# Since: 2.12
##
@@ -3247,8 +3247,8 @@
##
# @SshHostKeyCheckHashType:
#
-# @md5 The given hash is an md5 hash
-# @sha1 The given hash is an sha1 hash
+# @md5: The given hash is an md5 hash
+# @sha1: The given hash is an sha1 hash
#
# Since: 2.12
##
@@ -3258,8 +3258,8 @@
##
# @SshHostKeyHash:
#
-# @type The hash algorithm used for the hash
-# @hash The expected hash value
+# @type: The hash algorithm used for the hash
+# @hash: The expected hash value
#
# Since: 2.12
##
@@ -4265,13 +4265,13 @@
#
# Driver specific image creation options for file.
#
-# @filename Filename for the new image file
-# @size Size of the virtual disk in bytes
-# @preallocation Preallocation mode for the new image (default: off;
-# allowed values: off,
-# falloc (if defined CONFIG_POSIX_FALLOCATE),
-# full (if defined CONFIG_POSIX))
-# @nocow Turn off copy-on-write (valid only on btrfs; default: off)
+# @filename: Filename for the new image file
+# @size: Size of the virtual disk in bytes
+# @preallocation: Preallocation mode for the new image (default: off;
+# allowed values: off,
+# falloc (if defined CONFIG_POSIX_FALLOCATE),
+# full (if defined CONFIG_POSIX))
+# @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
#
# Since: 2.12
##
@@ -4286,12 +4286,12 @@
#
# Driver specific image creation options for gluster.
#
-# @location Where to store the new image file
-# @size Size of the virtual disk in bytes
-# @preallocation Preallocation mode for the new image (default: off;
-# allowed values: off,
-# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
-# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
+# @location: Where to store the new image file
+# @size: Size of the virtual disk in bytes
+# @preallocation: Preallocation mode for the new image (default: off;
+# allowed values: off,
+# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
+# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
#
# Since: 2.12
##
@@ -4305,11 +4305,11 @@
#
# Driver specific image creation options for LUKS.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @preallocation Preallocation mode for the new image
-# (since: 4.2)
-# (default: off; allowed values: off, metadata, falloc, full)
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @preallocation: Preallocation mode for the new image
+# (since: 4.2)
+# (default: off; allowed values: off, metadata, falloc, full)
#
# Since: 2.12
##
@@ -4324,8 +4324,8 @@
#
# Driver specific image creation options for NFS.
#
-# @location Where to store the new image file
-# @size Size of the virtual disk in bytes
+# @location: Where to store the new image file
+# @size: Size of the virtual disk in bytes
#
# Since: 2.12
##
@@ -4338,9 +4338,9 @@
#
# Driver specific image creation options for parallels.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @cluster-size Cluster size in bytes (default: 1 MB)
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @cluster-size: Cluster size in bytes (default: 1 MB)
#
# Since: 2.12
##
@@ -4354,11 +4354,11 @@
#
# Driver specific image creation options for qcow.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @backing-file File name of the backing file if a backing file
-# should be used
-# @encrypt Encryption options if the image should be encrypted
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @backing-file: File name of the backing file if a backing file
+# should be used
+# @encrypt: Encryption options if the image should be encrypted
#
# Since: 2.12
##
@@ -4385,24 +4385,24 @@
#
# Driver specific image creation options for qcow2.
#
-# @file Node to create the image format on
-# @data-file Node to use as an external data file in which all guest
-# data is stored so that only metadata remains in the qcow2
-# file (since: 4.0)
-# @data-file-raw True if the external data file must stay valid as a
-# standalone (read-only) raw image without looking at qcow2
-# metadata (default: false; since: 4.0)
-# @size Size of the virtual disk in bytes
-# @version Compatibility level (default: v3)
-# @backing-file File name of the backing file if a backing file
-# should be used
-# @backing-fmt Name of the block driver to use for the backing file
-# @encrypt Encryption options if the image should be encrypted
-# @cluster-size qcow2 cluster size in bytes (default: 65536)
-# @preallocation Preallocation mode for the new image (default: off;
-# allowed values: off, falloc, full, metadata)
-# @lazy-refcounts True if refcounts may be updated lazily (default: off)
-# @refcount-bits Width of reference counts in bits (default: 16)
+# @file: Node to create the image format on
+# @data-file: Node to use as an external data file in which all guest
+# data is stored so that only metadata remains in the qcow2
+# file (since: 4.0)
+# @data-file-raw: True if the external data file must stay valid as a
+# standalone (read-only) raw image without looking at qcow2
+# metadata (default: false; since: 4.0)
+# @size: Size of the virtual disk in bytes
+# @version: Compatibility level (default: v3)
+# @backing-file: File name of the backing file if a backing file
+# should be used
+# @backing-fmt: Name of the block driver to use for the backing file
+# @encrypt: Encryption options if the image should be encrypted
+# @cluster-size: qcow2 cluster size in bytes (default: 65536)
+# @preallocation: Preallocation mode for the new image (default: off;
+# allowed values: off, falloc, full, metadata)
+# @lazy-refcounts: True if refcounts may be updated lazily (default: off)
+# @refcount-bits: Width of reference counts in bits (default: 16)
#
# Since: 2.12
##
@@ -4425,13 +4425,13 @@
#
# Driver specific image creation options for qed.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @backing-file File name of the backing file if a backing file
-# should be used
-# @backing-fmt Name of the block driver to use for the backing file
-# @cluster-size Cluster size in bytes (default: 65536)
-# @table-size L1/L2 table size (in clusters)
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @backing-file: File name of the backing file if a backing file
+# should be used
+# @backing-fmt: Name of the block driver to use for the backing file
+# @cluster-size: Cluster size in bytes (default: 65536)
+# @table-size: L1/L2 table size (in clusters)
#
# Since: 2.12
##
@@ -4448,10 +4448,10 @@
#
# Driver specific image creation options for rbd/Ceph.
#
-# @location Where to store the new image file. This location cannot
-# point to a snapshot.
-# @size Size of the virtual disk in bytes
-# @cluster-size RBD object size
+# @location: Where to store the new image file. This location cannot
+# point to a snapshot.
+# @size: Size of the virtual disk in bytes
+# @cluster-size: RBD object size
#
# Since: 2.12
##
@@ -4499,23 +4499,23 @@
#
# Driver specific image creation options for VMDK.
#
-# @file Where to store the new image file. This refers to the image
-# file for monolithcSparse and streamOptimized format, or the
-# descriptor file for other formats.
-# @size Size of the virtual disk in bytes
-# @extents Where to store the data extents. Required for monolithcFlat,
-# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
-# monolithicFlat, only one entry is required; for
-# twoGbMaxExtent* formats, the number of entries required is
-# calculated as extent_number = virtual_size / 2GB. Providing
-# more extents than will be used is an error.
-# @subformat The subformat of the VMDK image. Default: "monolithicSparse".
-# @backing-file The path of backing file. Default: no backing file is used.
-# @adapter-type The adapter type used to fill in the descriptor. Default: ide.
-# @hwversion Hardware version. The meaningful options are "4" or "6".
-# Default: "4".
-# @zeroed-grain Whether to enable zeroed-grain feature for sparse subformats.
-# Default: false.
+# @file: Where to store the new image file. This refers to the image
+# file for monolithcSparse and streamOptimized format, or the
+# descriptor file for other formats.
+# @size: Size of the virtual disk in bytes
+# @extents: Where to store the data extents. Required for monolithcFlat,
+# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
+# monolithicFlat, only one entry is required; for
+# twoGbMaxExtent* formats, the number of entries required is
+# calculated as extent_number = virtual_size / 2GB. Providing
+# more extents than will be used is an error.
+# @subformat: The subformat of the VMDK image. Default: "monolithicSparse".
+# @backing-file: The path of backing file. Default: no backing file is used.
+# @adapter-type: The adapter type used to fill in the descriptor. Default: ide.
+# @hwversion: Hardware version. The meaningful options are "4" or "6".
+# Default: "4".
+# @zeroed-grain: Whether to enable zeroed-grain feature for sparse subformats.
+# Default: false.
#
# Since: 4.0
##
@@ -4533,9 +4533,9 @@
##
# @SheepdogRedundancyType:
#
-# @full Create a fully replicated vdi with x copies
-# @erasure-coded Create an erasure coded vdi with x data strips and
-# y parity strips
+# @full: Create a fully replicated vdi with x copies
+# @erasure-coded: Create an erasure coded vdi with x data strips and
+# y parity strips
#
# Since: 2.12
##
@@ -4545,7 +4545,7 @@
##
# @SheepdogRedundancyFull:
#
-# @copies Number of copies to use (between 1 and 31)
+# @copies: Number of copies to use (between 1 and 31)
#
# Since: 2.12
##
@@ -4555,8 +4555,8 @@
##
# @SheepdogRedundancyErasureCoded:
#
-# @data-strips Number of data strips to use (one of {2,4,8,16})
-# @parity-strips Number of parity strips to use (between 1 and 15)
+# @data-strips: Number of data strips to use (one of {2,4,8,16})
+# @parity-strips: Number of parity strips to use (between 1 and 15)
#
# Since: 2.12
##
@@ -4580,13 +4580,13 @@
#
# Driver specific image creation options for Sheepdog.
#
-# @location Where to store the new image file
-# @size Size of the virtual disk in bytes
-# @backing-file File name of a base image
-# @preallocation Preallocation mode for the new image (default: off;
-# allowed values: off, full)
-# @redundancy Redundancy of the image
-# @object-size Object size of the image
+# @location: Where to store the new image file
+# @size: Size of the virtual disk in bytes
+# @backing-file: File name of a base image
+# @preallocation: Preallocation mode for the new image (default: off;
+# allowed values: off, full)
+# @redundancy: Redundancy of the image
+# @object-size: Object size of the image
#
# Since: 2.12
##
@@ -4603,8 +4603,8 @@
#
# Driver specific image creation options for SSH.
#
-# @location Where to store the new image file
-# @size Size of the virtual disk in bytes
+# @location: Where to store the new image file
+# @size: Size of the virtual disk in bytes
#
# Since: 2.12
##
@@ -4617,10 +4617,10 @@
#
# Driver specific image creation options for VDI.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @preallocation Preallocation mode for the new image (default: off;
-# allowed values: off, metadata)
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @preallocation: Preallocation mode for the new image (default: off;
+# allowed values: off, metadata)
#
# Since: 2.12
##
@@ -4645,17 +4645,17 @@
#
# Driver specific image creation options for vhdx.
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @log-size Log size in bytes, must be a multiple of 1 MB
-# (default: 1 MB)
-# @block-size Block size in bytes, must be a multiple of 1 MB and not
-# larger than 256 MB (default: automatically choose a block
-# size depending on the image size)
-# @subformat vhdx subformat (default: dynamic)
-# @block-state-zero Force use of payload blocks of type 'ZERO'. Non-standard,
-# but default. Do not set to 'off' when using 'qemu-img
-# convert' with subformat=dynamic.
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @log-size: Log size in bytes, must be a multiple of 1 MB
+# (default: 1 MB)
+# @block-size: Block size in bytes, must be a multiple of 1 MB and not
+# larger than 256 MB (default: automatically choose a block
+# size depending on the image size)
+# @subformat: vhdx subformat (default: dynamic)
+# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
+# but default. Do not set to 'off' when using 'qemu-img
+# convert' with subformat=dynamic.
#
# Since: 2.12
##
@@ -4683,12 +4683,12 @@
#
# Driver specific image creation options for vpc (VHD).
#
-# @file Node to create the image format on
-# @size Size of the virtual disk in bytes
-# @subformat vhdx subformat (default: dynamic)
-# @force-size Force use of the exact byte size instead of rounding to the
-# next size that can be represented in CHS geometry
-# (default: false)
+# @file: Node to create the image format on
+# @size: Size of the virtual disk in bytes
+# @subformat: vhdx subformat (default: dynamic)
+# @force-size: Force use of the exact byte size instead of rounding to the
+# next size that can be represented in CHS geometry
+# (default: false)
#
# Since: 2.12
##
@@ -4703,7 +4703,7 @@
#
# Options for creating an image format on a given node.
#
-# @driver block driver to create the image format
+# @driver: block driver to create the image format
#
# Since: 2.12
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-06 17:30 ` [PATCH 08/29] qapi: Use ':' after @argument in doc comments Peter Maydell
@ 2020-02-07 9:28 ` Markus Armbruster
2020-02-07 9:33 ` Max Reitz
2020-02-07 10:24 ` Kevin Wolf
0 siblings, 2 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 9:28 UTC (permalink / raw)
To: Peter Maydell
Cc: Kevin Wolf, Daniel P. Berrangé,
qemu-devel, Michael Roth, Stefan Hajnoczi, Max Reitz, John Snow
Peter Maydell <peter.maydell@linaro.org> writes:
> Some qapi doc comments have forgotten the ':' after the
> @argument, like this:
>
> # @filename Filename for the new image file
> # @size Size of the virtual disk in bytes
>
> The result is that these are parsed as part of the body
> text and appear as a run-on line:
> filename Filename for the new image file size Size of the virtual disk in bytes"
> followed by
> filename: string
> Not documented
> size: int
> Not documented
>
> in the 'Members' section.
Easy error to make, and due to the "anything goes" nature of the doc
comment syntax, the QAPI generator won't help you.
>
> Correct the formatting.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/block-core.json | 236 +++++++++++++++++++++----------------------
> 1 file changed, 118 insertions(+), 118 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 372f35ee5f0..076a4a4808e 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -3235,9 +3235,9 @@
> ##
> # @SshHostKeyCheckMode:
> #
> -# @none Don't check the host key at all
> -# @hash Compare the host key with a given hash
> -# @known_hosts Check the host key against the known_hosts file
> +# @none: Don't check the host key at all
> +# @hash: Compare the host key with a given hash
> +# @known_hosts: Check the host key against the known_hosts file
> #
> # Since: 2.12
> ##
> @@ -3247,8 +3247,8 @@
> ##
> # @SshHostKeyCheckHashType:
> #
> -# @md5 The given hash is an md5 hash
> -# @sha1 The given hash is an sha1 hash
> +# @md5: The given hash is an md5 hash
> +# @sha1: The given hash is an sha1 hash
> #
> # Since: 2.12
> ##
> @@ -3258,8 +3258,8 @@
> ##
> # @SshHostKeyHash:
> #
> -# @type The hash algorithm used for the hash
> -# @hash The expected hash value
> +# @type: The hash algorithm used for the hash
> +# @hash: The expected hash value
> #
> # Since: 2.12
> ##
> @@ -4265,13 +4265,13 @@
> #
> # Driver specific image creation options for file.
> #
> -# @filename Filename for the new image file
> -# @size Size of the virtual disk in bytes
> -# @preallocation Preallocation mode for the new image (default: off;
> -# allowed values: off,
> -# falloc (if defined CONFIG_POSIX_FALLOCATE),
> -# full (if defined CONFIG_POSIX))
> -# @nocow Turn off copy-on-write (valid only on btrfs; default: off)
> +# @filename: Filename for the new image file
> +# @size: Size of the virtual disk in bytes
> +# @preallocation: Preallocation mode for the new image (default: off;
> +# allowed values: off,
> +# falloc (if defined CONFIG_POSIX_FALLOCATE),
> +# full (if defined CONFIG_POSIX))
> +# @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
> #
> # Since: 2.12
> ##
> @@ -4286,12 +4286,12 @@
> #
> # Driver specific image creation options for gluster.
> #
> -# @location Where to store the new image file
> -# @size Size of the virtual disk in bytes
> -# @preallocation Preallocation mode for the new image (default: off;
> -# allowed values: off,
> -# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
> -# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
> +# @location: Where to store the new image file
> +# @size: Size of the virtual disk in bytes
> +# @preallocation: Preallocation mode for the new image (default: off;
> +# allowed values: off,
> +# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
> +# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
> #
> # Since: 2.12
> ##
> @@ -4305,11 +4305,11 @@
> #
> # Driver specific image creation options for LUKS.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @preallocation Preallocation mode for the new image
> -# (since: 4.2)
> -# (default: off; allowed values: off, metadata, falloc, full)
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @preallocation: Preallocation mode for the new image
> +# (since: 4.2)
> +# (default: off; allowed values: off, metadata, falloc, full)
> #
> # Since: 2.12
> ##
> @@ -4324,8 +4324,8 @@
> #
> # Driver specific image creation options for NFS.
> #
> -# @location Where to store the new image file
> -# @size Size of the virtual disk in bytes
> +# @location: Where to store the new image file
> +# @size: Size of the virtual disk in bytes
> #
> # Since: 2.12
> ##
> @@ -4338,9 +4338,9 @@
> #
> # Driver specific image creation options for parallels.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @cluster-size Cluster size in bytes (default: 1 MB)
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @cluster-size: Cluster size in bytes (default: 1 MB)
> #
> # Since: 2.12
> ##
> @@ -4354,11 +4354,11 @@
> #
> # Driver specific image creation options for qcow.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @backing-file File name of the backing file if a backing file
> -# should be used
> -# @encrypt Encryption options if the image should be encrypted
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @backing-file: File name of the backing file if a backing file
> +# should be used
> +# @encrypt: Encryption options if the image should be encrypted
> #
> # Since: 2.12
> ##
> @@ -4385,24 +4385,24 @@
> #
> # Driver specific image creation options for qcow2.
> #
> -# @file Node to create the image format on
> -# @data-file Node to use as an external data file in which all guest
> -# data is stored so that only metadata remains in the qcow2
> -# file (since: 4.0)
> -# @data-file-raw True if the external data file must stay valid as a
> -# standalone (read-only) raw image without looking at qcow2
> -# metadata (default: false; since: 4.0)
> -# @size Size of the virtual disk in bytes
> -# @version Compatibility level (default: v3)
> -# @backing-file File name of the backing file if a backing file
> -# should be used
> -# @backing-fmt Name of the block driver to use for the backing file
> -# @encrypt Encryption options if the image should be encrypted
> -# @cluster-size qcow2 cluster size in bytes (default: 65536)
> -# @preallocation Preallocation mode for the new image (default: off;
> -# allowed values: off, falloc, full, metadata)
> -# @lazy-refcounts True if refcounts may be updated lazily (default: off)
> -# @refcount-bits Width of reference counts in bits (default: 16)
> +# @file: Node to create the image format on
> +# @data-file: Node to use as an external data file in which all guest
> +# data is stored so that only metadata remains in the qcow2
> +# file (since: 4.0)
> +# @data-file-raw: True if the external data file must stay valid as a
> +# standalone (read-only) raw image without looking at qcow2
> +# metadata (default: false; since: 4.0)
> +# @size: Size of the virtual disk in bytes
> +# @version: Compatibility level (default: v3)
> +# @backing-file: File name of the backing file if a backing file
> +# should be used
> +# @backing-fmt: Name of the block driver to use for the backing file
> +# @encrypt: Encryption options if the image should be encrypted
> +# @cluster-size: qcow2 cluster size in bytes (default: 65536)
> +# @preallocation: Preallocation mode for the new image (default: off;
> +# allowed values: off, falloc, full, metadata)
> +# @lazy-refcounts: True if refcounts may be updated lazily (default: off)
> +# @refcount-bits: Width of reference counts in bits (default: 16)
> #
> # Since: 2.12
> ##
> @@ -4425,13 +4425,13 @@
> #
> # Driver specific image creation options for qed.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @backing-file File name of the backing file if a backing file
> -# should be used
> -# @backing-fmt Name of the block driver to use for the backing file
> -# @cluster-size Cluster size in bytes (default: 65536)
> -# @table-size L1/L2 table size (in clusters)
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @backing-file: File name of the backing file if a backing file
> +# should be used
> +# @backing-fmt: Name of the block driver to use for the backing file
> +# @cluster-size: Cluster size in bytes (default: 65536)
> +# @table-size: L1/L2 table size (in clusters)
> #
> # Since: 2.12
> ##
> @@ -4448,10 +4448,10 @@
> #
> # Driver specific image creation options for rbd/Ceph.
> #
> -# @location Where to store the new image file. This location cannot
> -# point to a snapshot.
> -# @size Size of the virtual disk in bytes
> -# @cluster-size RBD object size
> +# @location: Where to store the new image file. This location cannot
> +# point to a snapshot.
> +# @size: Size of the virtual disk in bytes
> +# @cluster-size: RBD object size
> #
> # Since: 2.12
> ##
> @@ -4499,23 +4499,23 @@
> #
> # Driver specific image creation options for VMDK.
> #
> -# @file Where to store the new image file. This refers to the image
> -# file for monolithcSparse and streamOptimized format, or the
> -# descriptor file for other formats.
> -# @size Size of the virtual disk in bytes
> -# @extents Where to store the data extents. Required for monolithcFlat,
> -# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
> -# monolithicFlat, only one entry is required; for
> -# twoGbMaxExtent* formats, the number of entries required is
> -# calculated as extent_number = virtual_size / 2GB. Providing
> -# more extents than will be used is an error.
> -# @subformat The subformat of the VMDK image. Default: "monolithicSparse".
> -# @backing-file The path of backing file. Default: no backing file is used.
> -# @adapter-type The adapter type used to fill in the descriptor. Default: ide.
> -# @hwversion Hardware version. The meaningful options are "4" or "6".
> -# Default: "4".
> -# @zeroed-grain Whether to enable zeroed-grain feature for sparse subformats.
> -# Default: false.
> +# @file: Where to store the new image file. This refers to the image
> +# file for monolithcSparse and streamOptimized format, or the
> +# descriptor file for other formats.
> +# @size: Size of the virtual disk in bytes
> +# @extents: Where to store the data extents. Required for monolithcFlat,
> +# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
> +# monolithicFlat, only one entry is required; for
> +# twoGbMaxExtent* formats, the number of entries required is
> +# calculated as extent_number = virtual_size / 2GB. Providing
> +# more extents than will be used is an error.
> +# @subformat: The subformat of the VMDK image. Default: "monolithicSparse".
> +# @backing-file: The path of backing file. Default: no backing file is used.
> +# @adapter-type: The adapter type used to fill in the descriptor. Default: ide.
> +# @hwversion: Hardware version. The meaningful options are "4" or "6".
> +# Default: "4".
> +# @zeroed-grain: Whether to enable zeroed-grain feature for sparse subformats.
> +# Default: false.
> #
> # Since: 4.0
> ##
> @@ -4533,9 +4533,9 @@
> ##
> # @SheepdogRedundancyType:
> #
> -# @full Create a fully replicated vdi with x copies
> -# @erasure-coded Create an erasure coded vdi with x data strips and
> -# y parity strips
> +# @full: Create a fully replicated vdi with x copies
> +# @erasure-coded: Create an erasure coded vdi with x data strips and
> +# y parity strips
> #
> # Since: 2.12
> ##
> @@ -4545,7 +4545,7 @@
> ##
> # @SheepdogRedundancyFull:
> #
> -# @copies Number of copies to use (between 1 and 31)
> +# @copies: Number of copies to use (between 1 and 31)
> #
> # Since: 2.12
> ##
> @@ -4555,8 +4555,8 @@
> ##
> # @SheepdogRedundancyErasureCoded:
> #
> -# @data-strips Number of data strips to use (one of {2,4,8,16})
> -# @parity-strips Number of parity strips to use (between 1 and 15)
> +# @data-strips: Number of data strips to use (one of {2,4,8,16})
> +# @parity-strips: Number of parity strips to use (between 1 and 15)
> #
> # Since: 2.12
> ##
> @@ -4580,13 +4580,13 @@
> #
> # Driver specific image creation options for Sheepdog.
> #
> -# @location Where to store the new image file
> -# @size Size of the virtual disk in bytes
> -# @backing-file File name of a base image
> -# @preallocation Preallocation mode for the new image (default: off;
> -# allowed values: off, full)
> -# @redundancy Redundancy of the image
> -# @object-size Object size of the image
> +# @location: Where to store the new image file
> +# @size: Size of the virtual disk in bytes
> +# @backing-file: File name of a base image
> +# @preallocation: Preallocation mode for the new image (default: off;
> +# allowed values: off, full)
> +# @redundancy: Redundancy of the image
> +# @object-size: Object size of the image
> #
> # Since: 2.12
> ##
> @@ -4603,8 +4603,8 @@
> #
> # Driver specific image creation options for SSH.
> #
> -# @location Where to store the new image file
> -# @size Size of the virtual disk in bytes
> +# @location: Where to store the new image file
> +# @size: Size of the virtual disk in bytes
> #
> # Since: 2.12
> ##
> @@ -4617,10 +4617,10 @@
> #
> # Driver specific image creation options for VDI.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @preallocation Preallocation mode for the new image (default: off;
> -# allowed values: off, metadata)
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @preallocation: Preallocation mode for the new image (default: off;
> +# allowed values: off, metadata)
> #
> # Since: 2.12
> ##
> @@ -4645,17 +4645,17 @@
> #
> # Driver specific image creation options for vhdx.
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @log-size Log size in bytes, must be a multiple of 1 MB
> -# (default: 1 MB)
> -# @block-size Block size in bytes, must be a multiple of 1 MB and not
> -# larger than 256 MB (default: automatically choose a block
> -# size depending on the image size)
> -# @subformat vhdx subformat (default: dynamic)
> -# @block-state-zero Force use of payload blocks of type 'ZERO'. Non-standard,
> -# but default. Do not set to 'off' when using 'qemu-img
> -# convert' with subformat=dynamic.
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @log-size: Log size in bytes, must be a multiple of 1 MB
> +# (default: 1 MB)
> +# @block-size: Block size in bytes, must be a multiple of 1 MB and not
> +# larger than 256 MB (default: automatically choose a block
> +# size depending on the image size)
> +# @subformat: vhdx subformat (default: dynamic)
> +# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
> +# but default. Do not set to 'off' when using 'qemu-img
> +# convert' with subformat=dynamic.
> #
> # Since: 2.12
> ##
> @@ -4683,12 +4683,12 @@
> #
> # Driver specific image creation options for vpc (VHD).
> #
> -# @file Node to create the image format on
> -# @size Size of the virtual disk in bytes
> -# @subformat vhdx subformat (default: dynamic)
> -# @force-size Force use of the exact byte size instead of rounding to the
> -# next size that can be represented in CHS geometry
> -# (default: false)
> +# @file: Node to create the image format on
> +# @size: Size of the virtual disk in bytes
> +# @subformat: vhdx subformat (default: dynamic)
> +# @force-size: Force use of the exact byte size instead of rounding to the
> +# next size that can be represented in CHS geometry
> +# (default: false)
> #
> # Since: 2.12
> ##
> @@ -4703,7 +4703,7 @@
> #
> # Options for creating an image format on a given node.
> #
> -# @driver block driver to create the image format
> +# @driver: block driver to create the image format
> #
> # Since: 2.12
> ##
Loses the visual alignment. I'm okay with that, but the folks who took
the trouble to align the text may have different ideas. Cc'ing Kevin
and Max.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 9:28 ` Markus Armbruster
@ 2020-02-07 9:33 ` Max Reitz
2020-02-07 10:24 ` Kevin Wolf
1 sibling, 0 replies; 77+ messages in thread
From: Max Reitz @ 2020-02-07 9:33 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell
Cc: Kevin Wolf, Daniel P. Berrangé,
qemu-devel, Michael Roth, Stefan Hajnoczi, John Snow
[-- Attachment #1.1: Type: text/plain, Size: 254 bytes --]
On 07.02.20 10:28, Markus Armbruster wrote:
[...]
> Loses the visual alignment. I'm okay with that, but the folks who took
> the trouble to align the text may have different ideas. Cc'ing Kevin
> and Max.
I certainly don’t mind.
Max
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 9:28 ` Markus Armbruster
2020-02-07 9:33 ` Max Reitz
@ 2020-02-07 10:24 ` Kevin Wolf
2020-02-07 11:05 ` Peter Maydell
1 sibling, 1 reply; 77+ messages in thread
From: Kevin Wolf @ 2020-02-07 10:24 UTC (permalink / raw)
To: Markus Armbruster
Cc: Peter Maydell, Daniel P. Berrangé,
qemu-devel, Michael Roth, Stefan Hajnoczi, Max Reitz, John Snow
Am 07.02.2020 um 10:28 hat Markus Armbruster geschrieben:
> Peter Maydell <peter.maydell@linaro.org> writes:
> > @@ -4703,7 +4703,7 @@
> > #
> > # Options for creating an image format on a given node.
> > #
> > -# @driver block driver to create the image format
> > +# @driver: block driver to create the image format
> > #
> > # Since: 2.12
> > ##
>
> Loses the visual alignment. I'm okay with that, but the folks who took
> the trouble to align the text may have different ideas. Cc'ing Kevin
> and Max.
I think the documentation is much easier to parse visually with aligned
text as it makes both the option name and the whole part of the comment
that documents options stand out clearly.
Of course, "It is the QEMU coding style." would trump everything, but as
long as there isn't a style guide that requires a wall of text without
spaces and alignment, I'd prefer to leave at least those aligned texts
in place that we have.
Kevin
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 10:24 ` Kevin Wolf
@ 2020-02-07 11:05 ` Peter Maydell
2020-02-07 14:43 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 11:05 UTC (permalink / raw)
To: Kevin Wolf
Cc: Daniel P. Berrangé,
QEMU Developers, Michael Roth, Markus Armbruster,
Stefan Hajnoczi, Max Reitz, John Snow
On Fri, 7 Feb 2020 at 10:24, Kevin Wolf <kwolf@redhat.com> wrote:
>
> Am 07.02.2020 um 10:28 hat Markus Armbruster geschrieben:
> > Peter Maydell <peter.maydell@linaro.org> writes:
> > > @@ -4703,7 +4703,7 @@
> > > #
> > > # Options for creating an image format on a given node.
> > > #
> > > -# @driver block driver to create the image format
> > > +# @driver: block driver to create the image format
> > > #
> > > # Since: 2.12
> > > ##
> >
> > Loses the visual alignment. I'm okay with that, but the folks who took
> > the trouble to align the text may have different ideas. Cc'ing Kevin
> > and Max.
>
> I think the documentation is much easier to parse visually with aligned
> text as it makes both the option name and the whole part of the comment
> that documents options stand out clearly.
>
> Of course, "It is the QEMU coding style." would trump everything, but as
> long as there isn't a style guide that requires a wall of text without
> spaces and alignment, I'd prefer to leave at least those aligned texts
> in place that we have.
So, the other way to handle this would be to say "the @foo: can have
an arbitrary amount of whitespace after it", and have the doc comment
parser strip out that many characters of extra whitespace there and
on the subsequent lines. The downside is that then you would have no
way of having a comment for an argument which started with rST markup
that required leading whitespace. I think this pretty much would just
mean that you can't start an argument description with a blockquote,
so we don't lose much, but there is a difference currently between:
@arg: In the current parser this is a blockquote
Blockquote line 2
But this is a non-blockquoted line still in @arg's description
and
@arg: This is not blockquoted, it's just a line
So is this
and this
I can make the parser work the other way if people prefer that though
(and then the first example above would become a syntax error because
the 3rd line would be unexpectedly de-indented).
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 11:05 ` Peter Maydell
@ 2020-02-07 14:43 ` Markus Armbruster
2020-02-07 15:01 ` Max Reitz
2020-02-07 15:24 ` Peter Maydell
0 siblings, 2 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 14:43 UTC (permalink / raw)
To: Peter Maydell
Cc: Kevin Wolf, Daniel P. Berrangé,
Michael Roth, QEMU Developers, Max Reitz, Stefan Hajnoczi,
John Snow
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 10:24, Kevin Wolf <kwolf@redhat.com> wrote:
>>
>> Am 07.02.2020 um 10:28 hat Markus Armbruster geschrieben:
>> > Peter Maydell <peter.maydell@linaro.org> writes:
>> > > @@ -4703,7 +4703,7 @@
>> > > #
>> > > # Options for creating an image format on a given node.
>> > > #
>> > > -# @driver block driver to create the image format
>> > > +# @driver: block driver to create the image format
>> > > #
>> > > # Since: 2.12
>> > > ##
>> >
>> > Loses the visual alignment. I'm okay with that, but the folks who took
>> > the trouble to align the text may have different ideas. Cc'ing Kevin
>> > and Max.
>>
>> I think the documentation is much easier to parse visually with aligned
>> text as it makes both the option name and the whole part of the comment
>> that documents options stand out clearly.
>>
>> Of course, "It is the QEMU coding style." would trump everything, but as
>> long as there isn't a style guide that requires a wall of text without
>> spaces and alignment, I'd prefer to leave at least those aligned texts
>> in place that we have.
>
> So, the other way to handle this would be to say "the @foo: can have
> an arbitrary amount of whitespace after it", and have the doc comment
> parser strip out that many characters of extra whitespace there and
> on the subsequent lines. The downside is that then you would have no
> way of having a comment for an argument which started with rST markup
> that required leading whitespace. I think this pretty much would just
> mean that you can't start an argument description with a blockquote,
> so we don't lose much, but there is a difference currently between:
>
> @arg: In the current parser this is a blockquote
> Blockquote line 2
>
> But this is a non-blockquoted line still in @arg's description
>
> and
>
> @arg: This is not blockquoted, it's just a line
> So is this
> and this
>
> I can make the parser work the other way if people prefer that though
> (and then the first example above would become a syntax error because
> the 3rd line would be unexpectedly de-indented).
Let me ignore rST details for a bit.
The prevailing schema style looks like this:
# @file: Node to create the image format on
# @size: Size of the virtual disk in bytes
# @log-size: Log size in bytes, must be a multiple of 1 MB
# (default: 1 MB)
# @block-size: Block size in bytes, must be a multiple of 1 MB and not
# larger than 256 MB (default: automatically choose a block
# size depending on the image size)
# @subformat: vhdx subformat (default: dynamic)
# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
# but default. Do not set to 'off' when using 'qemu-img
# convert' with subformat=dynamic.
Peter's patch converts to it. Can't fault him for converting to the
prevailing style.
Trouble is the prevailing style is ugly, and can waste massive amounts
of screen real estate when both the identifier and the explaining text
are long.
block*.json's style looks like this:
# @file: Node to create the image format on
# @size: Size of the virtual disk in bytes
# @log-size: Log size in bytes, must be a multiple of 1 MB
# (default: 1 MB)
# @block-size: Block size in bytes, must be a multiple of 1 MB and not
# larger than 256 MB (default: automatically choose a block
# size depending on the image size)
# @subformat: vhdx subformat (default: dynamic)
# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
# but default. Do not set to 'off' when using 'qemu-img
# convert' with subformat=dynamic.
I dislike this style, too. It's less ugly, until you add a longer
member. Then you either accept inconsistent indentation, or reindent
all the other members. Blech.
Here's a style I'd dislike less:
# @file: Node to create the image format on
#
# @size: Size of the virtual disk in bytes
#
# @log-size: Log size in bytes, must be a multiple of 1 MB
# (default: 1 MB)
#
# @block-size: Block size in bytes, must be a multiple of 1 MB and not
# larger than 256 MB (default: automatically choose a block
# size depending on the image size)
#
# @subformat: vhdx subformat (default: dynamic)
#
# @block-state-zero: Force use of payload blocks of type 'ZERO'.
# Non-standard, but default. Do not set to 'off' when using
# 'qemu-img convert' with subformat=dynamic.
Or maybe even
# @file:
# Node to create the image format on
#
# @size:
# Size of the virtual disk in bytes
#
# @log-size:
# Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
#
# @block-size:
# Block size in bytes, must be a multiple of 1 MB and not larger
# than 256 MB (default: automatically choose a block size depending
# on the image size)
#
# @subformat:
# vhdx subformat (default: dynamic)
#
# @block-state-zero:
# Force use of payload blocks of type 'ZERO'. Non-standard, but
# default. Do not set to 'off' when using 'qemu-img convert' with
# subformat=dynamic.
With both these styles, member names stand out reasonably well, and I
don't have to fiddle with indentation when adding or removing members.
With the second one, I don't have to fiddle with indentation at all.
The second one might be the better fit for rST, but that's for Peter to
judge.
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 14:43 ` Markus Armbruster
@ 2020-02-07 15:01 ` Max Reitz
2020-02-07 15:40 ` Kevin Wolf
2020-02-07 15:24 ` Peter Maydell
1 sibling, 1 reply; 77+ messages in thread
From: Max Reitz @ 2020-02-07 15:01 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell
Cc: Kevin Wolf, Daniel P. Berrangé,
QEMU Developers, Michael Roth, Stefan Hajnoczi, John Snow
[-- Attachment #1.1: Type: text/plain, Size: 809 bytes --]
On 07.02.20 15:43, Markus Armbruster wrote:
[...]
> # @file:
> # Node to create the image format on
> #
> # @size:
> # Size of the virtual disk in bytes
> #
> # @log-size:
> # Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
> #
> # @block-size:
> # Block size in bytes, must be a multiple of 1 MB and not larger
> # than 256 MB (default: automatically choose a block size depending
> # on the image size)
> #
> # @subformat:
> # vhdx subformat (default: dynamic)
> #
> # @block-state-zero:
> # Force use of payload blocks of type 'ZERO'. Non-standard, but
> # default. Do not set to 'off' when using 'qemu-img convert' with
> # subformat=dynamic.
FWIW, I like this one.
Max
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 15:01 ` Max Reitz
@ 2020-02-07 15:40 ` Kevin Wolf
0 siblings, 0 replies; 77+ messages in thread
From: Kevin Wolf @ 2020-02-07 15:40 UTC (permalink / raw)
To: Max Reitz
Cc: Peter Maydell, Daniel P. Berrangé,
QEMU Developers, Michael Roth, Markus Armbruster,
Stefan Hajnoczi, John Snow
[-- Attachment #1: Type: text/plain, Size: 962 bytes --]
Am 07.02.2020 um 16:01 hat Max Reitz geschrieben:
> On 07.02.20 15:43, Markus Armbruster wrote:
>
> [...]
>
> > # @file:
> > # Node to create the image format on
> > #
> > # @size:
> > # Size of the virtual disk in bytes
> > #
> > # @log-size:
> > # Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
> > #
> > # @block-size:
> > # Block size in bytes, must be a multiple of 1 MB and not larger
> > # than 256 MB (default: automatically choose a block size depending
> > # on the image size)
> > #
> > # @subformat:
> > # vhdx subformat (default: dynamic)
> > #
> > # @block-state-zero:
> > # Force use of payload blocks of type 'ZERO'. Non-standard, but
> > # default. Do not set to 'off' when using 'qemu-img convert' with
> > # subformat=dynamic.
>
> FWIW, I like this one.
Looks like a workable compromise to me, too.
Kevin
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 801 bytes --]
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 14:43 ` Markus Armbruster
2020-02-07 15:01 ` Max Reitz
@ 2020-02-07 15:24 ` Peter Maydell
2020-02-08 7:54 ` Markus Armbruster
1 sibling, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 15:24 UTC (permalink / raw)
To: Markus Armbruster
Cc: Kevin Wolf, Daniel P. Berrangé,
Michael Roth, QEMU Developers, Max Reitz, Stefan Hajnoczi,
John Snow
On Fri, 7 Feb 2020 at 14:43, Markus Armbruster <armbru@redhat.com> wrote:
> Here's a style I'd dislike less:
>
> # @file: Node to create the image format on
> #
> # @size: Size of the virtual disk in bytes
> #
> # @log-size: Log size in bytes, must be a multiple of 1 MB
> # (default: 1 MB)
> #
> # @block-size: Block size in bytes, must be a multiple of 1 MB and not
> # larger than 256 MB (default: automatically choose a block
> # size depending on the image size)
> #
> # @subformat: vhdx subformat (default: dynamic)
> #
> # @block-state-zero: Force use of payload blocks of type 'ZERO'.
> # Non-standard, but default. Do not set to 'off' when using
> # 'qemu-img convert' with subformat=dynamic.
The problem with this one is that there's no way for the
doc-comment parser to know how far lines 2,3... are
supposed to be indented. Unlike the block-quote issue, this
is a real problem, because it's not possible to distinguish:
# @foo: - Here's a bulleted list
# Line 2 of the list item should indent to match the first
# @bar: - A one item list
# A line not in the list
which is the kind of thing that will show up in real-world
usage. (Unless you wanted to say "always 4-space indent" or something,
which I think would tend to result in a lot of accidental
over-indentation and unintended blockquotes in the output.)
> Or maybe even
>
> # @file:
> # Node to create the image format on
> #
> # @size:
> # Size of the virtual disk in bytes
> #
> # @log-size:
> # Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
> #
> # @block-size:
> # Block size in bytes, must be a multiple of 1 MB and not larger
> # than 256 MB (default: automatically choose a block size depending
> # on the image size)
> #
> # @subformat:
> # vhdx subformat (default: dynamic)
> #
> # @block-state-zero:
> # Force use of payload blocks of type 'ZERO'. Non-standard, but
> # default. Do not set to 'off' when using 'qemu-img convert' with
> # subformat=dynamic.
Conveniently this patchset already supports this format :-)
You can write either
# @foo: bar
# baz
# indented
or
# @foo:
# bar
# baz
# indented
and they'll come out to the same thing (the parser.py code
sends the same doc strings to the rST visitor).
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-07 15:24 ` Peter Maydell
@ 2020-02-08 7:54 ` Markus Armbruster
2020-02-08 13:22 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-08 7:54 UTC (permalink / raw)
To: Peter Maydell
Cc: Kevin Wolf, Daniel P. Berrangé,
QEMU Developers, Michael Roth, Max Reitz, Stefan Hajnoczi,
John Snow
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 14:43, Markus Armbruster <armbru@redhat.com> wrote:
>
>
>> Here's a style I'd dislike less:
[...]
>> # @file:
>> # Node to create the image format on
>> #
>> # @size:
>> # Size of the virtual disk in bytes
>> #
>> # @log-size:
>> # Log size in bytes, must be a multiple of 1 MB (default: 1 MB)
>> #
>> # @block-size:
>> # Block size in bytes, must be a multiple of 1 MB and not larger
>> # than 256 MB (default: automatically choose a block size depending
>> # on the image size)
>> #
>> # @subformat:
>> # vhdx subformat (default: dynamic)
>> #
>> # @block-state-zero:
>> # Force use of payload blocks of type 'ZERO'. Non-standard, but
>> # default. Do not set to 'off' when using 'qemu-img convert' with
>> # subformat=dynamic.
>
> Conveniently this patchset already supports this format :-)
> You can write either
>
> # @foo: bar
> # baz
> # indented
>
> or
> # @foo:
> # bar
> # baz
> # indented
>
> and they'll come out to the same thing (the parser.py code
> sends the same doc strings to the rST visitor).
If we enforce the second format in the QAPI schema parser, we save
ourselves the trouble of normalizing the first format to the second one.
We also promote more uniform style.
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments
2020-02-08 7:54 ` Markus Armbruster
@ 2020-02-08 13:22 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-08 13:22 UTC (permalink / raw)
To: Markus Armbruster
Cc: Kevin Wolf, Daniel P. Berrangé,
QEMU Developers, Michael Roth, Max Reitz, Stefan Hajnoczi,
John Snow
On Sat, 8 Feb 2020 at 07:54, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
> > Conveniently this patchset already supports this format :-)
> > You can write either
> >
> > # @foo: bar
> > # baz
> > # indented
> >
> > or
> > # @foo:
> > # bar
> > # baz
> > # indented
> >
> > and they'll come out to the same thing (the parser.py code
> > sends the same doc strings to the rST visitor).
>
> If we enforce the second format in the QAPI schema parser, we save
> ourselves the trouble of normalizing the first format to the second one.
> We also promote more uniform style.
You also end up requiring
# @foo:
# A short one-line description.
because it's the first style that makes this valid syntax:
# @foo: A short one-line description
And you're suggesting a big upheaval in doc comment style, because
lots of the existing doc comment syntax uses the first version.
I would really strongly prefer to not have "convert to supporting rST"
also mean "and we have to touch every single JSON doc comment
to convert away from a commonly used style that nobody has
complained about in the past, which doesn't compromise the ability
to include rST markup in the doc comment, and which was easy to
support in the doc generator". This patchset is already quite large
and has a lot of updates to QAPI doc comments. The one that makes
the widest set of changes (patch 9/29) is bigger than I'd like and I think
an important thing that makes it viable is that you can check with
git show that it really is just changing whitespace, not even line breaks.
Some of the style changes you're proposing would be much harder
to verify as safe and touch much more of the JSON. If you'd like
to do those I have no objection, but I really really don't want to
tangle that up with the already large amount of work involved
in transitioning away from texi to rST.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 09/29] qapi: Fix indent level on doc comments in json files
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (7 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 08/29] qapi: Use ':' after @argument in doc comments Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 9:31 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 10/29] qapi: Remove hardcoded tabs Peter Maydell
` (24 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
The texinfo doc generation doesn't care much about
indentation levels, but we would like to add a rST
backend, and rST does care about indentation.
Make the doc comments more strongly consistent about indentation
for multiline constructs like:
@arg: description line 1
description line 2
Returns: line one
line 2
so that there is always exactly one space after the
colon, and subsequent lines align with the first.
This commit is a purely whitespace change, and it does
not alter the generated .texi files (because the texi
generation code strips away all the extra whitespace).
This does mean that we end up with some over-length lines.
Note that when the documentation for an argument fits
on a single line like this:
@arg: one line only
then stray extra spaces after the ':' don't affect the
rST output, so I have not attempted to methodically
fix them, though the preference is a single space here too.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 776 +++++++++++++++++++--------------------
qapi/block.json | 14 +-
qapi/char.json | 8 +-
qapi/dump.json | 4 +-
qapi/introspect.json | 12 +-
qapi/job.json | 32 +-
qapi/machine-target.json | 18 +-
qapi/machine.json | 12 +-
qapi/migration.json | 198 +++++-----
qapi/misc-target.json | 8 +-
qapi/misc.json | 102 ++---
qapi/net.json | 20 +-
qapi/qdev.json | 10 +-
qapi/qom.json | 4 +-
qapi/rocker.json | 12 +-
qapi/run-state.json | 34 +-
qapi/sockets.json | 8 +-
qapi/trace.json | 14 +-
qapi/transaction.json | 4 +-
qapi/ui.json | 36 +-
20 files changed, 663 insertions(+), 663 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 076a4a4808e..006a0bf7a7c 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -162,7 +162,7 @@
# @backing-image: info of the backing image (since 1.6)
#
# @format-specific: structure supplying additional format-specific
-# information (since 1.7)
+# information (since 1.7)
#
# Since: 1.3
#
@@ -708,7 +708,7 @@
# Get a list of BlockInfo for all virtual block devices.
#
# Returns: a list of @BlockInfo describing each virtual block device. Filter
-# nodes that were created implicitly are skipped over.
+# nodes that were created implicitly are skipped over.
#
# Since: 0.14.0
#
@@ -1352,8 +1352,8 @@
# @existing: QEMU should look for an existing image file.
#
# @absolute-paths: QEMU should create a new image with absolute paths
-# for the backing file. If there is no backing file available, the new
-# image will not be backed either.
+# for the backing file. If there is no backing file available, the new
+# image will not be backed either.
#
# Since: 1.1
##
@@ -1370,8 +1370,8 @@
# @node-name: graph node name to generate the snapshot from (Since 2.0)
#
# @snapshot-file: the target of the new overlay image. If the file
-# exists, or if it is a device, the overlay will be created in the
-# existing file/device. Otherwise, a new file will be created.
+# exists, or if it is a device, the overlay will be created in the
+# existing file/device. Otherwise, a new file will be created.
#
# @snapshot-node-name: the graph node name of the new image (Since 2.0)
#
@@ -1456,8 +1456,8 @@
# a node name is autogenerated. (Since: 4.2)
#
# Note: @on-source-error and @on-target-error only affect background
-# I/O. If an error occurs during a guest write request, the device's
-# rerror/werror actions will be used.
+# I/O. If an error occurs during a guest write request, the device's
+# rerror/werror actions will be used.
#
# Since: 4.2
##
@@ -1578,13 +1578,13 @@
# to verify "image-node-name" is in the chain
# described by "device".
#
-# @device: The device name or node-name of the root node that owns
-# image-node-name.
+# @device: The device name or node-name of the root node that owns
+# image-node-name.
#
-# @backing-file: The string to write as the backing file. This
-# string is not validated, so care should be taken
-# when specifying the string or the image chain may
-# not be able to be reopened again.
+# @backing-file: The string to write as the backing file. This
+# string is not validated, so care should be taken
+# when specifying the string or the image chain may
+# not be able to be reopened again.
#
# Returns: Nothing on success
#
@@ -1605,7 +1605,7 @@
# @job-id: identifier for the newly-created block job. If
# omitted, the device name will be used. (Since 2.7)
#
-# @device: the device name or node-name of a root node
+# @device: the device name or node-name of a root node
#
# @base-node: The node name of the backing image to write data into.
# If not specified, this is the deepest backing image.
@@ -1625,36 +1625,36 @@
# node; other strings, even if addressing the same file, are not
# accepted (deprecated, use @base-node instead)
#
-# @backing-file: The backing file string to write into the overlay
-# image of 'top'. If 'top' is the active layer,
-# specifying a backing file string is an error. This
-# filename is not validated.
+# @backing-file: The backing file string to write into the overlay
+# image of 'top'. If 'top' is the active layer,
+# specifying a backing file string is an error. This
+# filename is not validated.
#
-# If a pathname string is such that it cannot be
-# resolved by QEMU, that means that subsequent QMP or
-# HMP commands must use node-names for the image in
-# question, as filename lookup methods will fail.
+# If a pathname string is such that it cannot be
+# resolved by QEMU, that means that subsequent QMP or
+# HMP commands must use node-names for the image in
+# question, as filename lookup methods will fail.
#
-# If not specified, QEMU will automatically determine
-# the backing file string to use, or error out if
-# there is no obvious choice. Care should be taken
-# when specifying the string, to specify a valid
-# filename or protocol.
-# (Since 2.1)
+# If not specified, QEMU will automatically determine
+# the backing file string to use, or error out if
+# there is no obvious choice. Care should be taken
+# when specifying the string, to specify a valid
+# filename or protocol.
+# (Since 2.1)
#
-# If top == base, that is an error.
-# If top == active, the job will not be completed by itself,
-# user needs to complete the job with the block-job-complete
-# command after getting the ready event. (Since 2.0)
+# If top == base, that is an error.
+# If top == active, the job will not be completed by itself,
+# user needs to complete the job with the block-job-complete
+# command after getting the ready event. (Since 2.0)
#
-# If the base image is smaller than top, then the base image
-# will be resized to be the same size as top. If top is
-# smaller than the base image, the base will not be
-# truncated. If you want the base image size to match the
-# size of the smaller top, you can safely truncate it
-# yourself once the commit operation successfully completes.
+# If the base image is smaller than top, then the base image
+# will be resized to be the same size as top. If top is
+# smaller than the base image, the base will not be
+# truncated. If you want the base image size to match the
+# size of the smaller top, you can safely truncate it
+# yourself once the commit operation successfully completes.
#
-# @speed: the maximum speed, in bytes per second
+# @speed: the maximum speed, in bytes per second
#
# @filter-node-name: the node name that should be assigned to the
# filter driver that the commit job inserts into the graph
@@ -2439,52 +2439,52 @@
# @iops_wr: write I/O operations per second
#
# @bps_max: total throughput limit during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @bps_rd_max: read throughput limit during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @bps_wr_max: write throughput limit during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @iops_max: total I/O operations per second during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @iops_rd_max: read I/O operations per second during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @iops_wr_max: write I/O operations per second during bursts,
-# in bytes (Since 1.7)
+# in bytes (Since 1.7)
#
# @bps_max_length: maximum length of the @bps_max burst
-# period, in seconds. It must only
-# be set if @bps_max is set as well.
-# Defaults to 1. (Since 2.6)
+# period, in seconds. It must only
+# be set if @bps_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @bps_rd_max_length: maximum length of the @bps_rd_max
-# burst period, in seconds. It must only
-# be set if @bps_rd_max is set as well.
-# Defaults to 1. (Since 2.6)
+# burst period, in seconds. It must only
+# be set if @bps_rd_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @bps_wr_max_length: maximum length of the @bps_wr_max
-# burst period, in seconds. It must only
-# be set if @bps_wr_max is set as well.
-# Defaults to 1. (Since 2.6)
+# burst period, in seconds. It must only
+# be set if @bps_wr_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @iops_max_length: maximum length of the @iops burst
-# period, in seconds. It must only
-# be set if @iops_max is set as well.
-# Defaults to 1. (Since 2.6)
+# period, in seconds. It must only
+# be set if @iops_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @iops_rd_max_length: maximum length of the @iops_rd_max
-# burst period, in seconds. It must only
-# be set if @iops_rd_max is set as well.
-# Defaults to 1. (Since 2.6)
+# burst period, in seconds. It must only
+# be set if @iops_rd_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @iops_wr_max_length: maximum length of the @iops_wr_max
-# burst period, in seconds. It must only
-# be set if @iops_wr_max is set as well.
-# Defaults to 1. (Since 2.6)
+# burst period, in seconds. It must only
+# be set if @iops_wr_max is set as well.
+# Defaults to 1. (Since 2.6)
#
# @iops_size: an I/O size in bytes (Since 1.7)
#
@@ -2511,31 +2511,31 @@
# transaction. All fields are optional. When setting limits, if a field is
# missing the current value is not changed.
#
-# @iops-total: limit total I/O operations per second
-# @iops-total-max: I/O operations burst
-# @iops-total-max-length: length of the iops-total-max burst period, in seconds
-# It must only be set if @iops-total-max is set as well.
-# @iops-read: limit read operations per second
-# @iops-read-max: I/O operations read burst
-# @iops-read-max-length: length of the iops-read-max burst period, in seconds
-# It must only be set if @iops-read-max is set as well.
-# @iops-write: limit write operations per second
-# @iops-write-max: I/O operations write burst
-# @iops-write-max-length: length of the iops-write-max burst period, in seconds
-# It must only be set if @iops-write-max is set as well.
-# @bps-total: limit total bytes per second
-# @bps-total-max: total bytes burst
-# @bps-total-max-length: length of the bps-total-max burst period, in seconds.
-# It must only be set if @bps-total-max is set as well.
-# @bps-read: limit read bytes per second
-# @bps-read-max: total bytes read burst
-# @bps-read-max-length: length of the bps-read-max burst period, in seconds
-# It must only be set if @bps-read-max is set as well.
-# @bps-write: limit write bytes per second
-# @bps-write-max: total bytes write burst
-# @bps-write-max-length: length of the bps-write-max burst period, in seconds
-# It must only be set if @bps-write-max is set as well.
-# @iops-size: when limiting by iops max size of an I/O in bytes
+# @iops-total: limit total I/O operations per second
+# @iops-total-max: I/O operations burst
+# @iops-total-max-length: length of the iops-total-max burst period, in seconds
+# It must only be set if @iops-total-max is set as well.
+# @iops-read: limit read operations per second
+# @iops-read-max: I/O operations read burst
+# @iops-read-max-length: length of the iops-read-max burst period, in seconds
+# It must only be set if @iops-read-max is set as well.
+# @iops-write: limit write operations per second
+# @iops-write-max: I/O operations write burst
+# @iops-write-max-length: length of the iops-write-max burst period, in seconds
+# It must only be set if @iops-write-max is set as well.
+# @bps-total: limit total bytes per second
+# @bps-total-max: total bytes burst
+# @bps-total-max-length: length of the bps-total-max burst period, in seconds.
+# It must only be set if @bps-total-max is set as well.
+# @bps-read: limit read bytes per second
+# @bps-read-max: total bytes read burst
+# @bps-read-max-length: length of the bps-read-max burst period, in seconds
+# It must only be set if @bps-read-max is set as well.
+# @bps-write: limit write bytes per second
+# @bps-write-max: total bytes write burst
+# @bps-write-max-length: length of the bps-write-max burst period, in seconds
+# It must only be set if @bps-write-max is set as well.
+# @iops-size: when limiting by iops max size of an I/O in bytes
#
# Since: 2.11
##
@@ -2582,28 +2582,28 @@
#
# @device: the device or node name of the top image
#
-# @base: the common backing file name.
-# It cannot be set if @base-node is also set.
+# @base: the common backing file name.
+# It cannot be set if @base-node is also set.
#
# @base-node: the node name of the backing file.
-# It cannot be set if @base is also set. (Since 2.8)
+# It cannot be set if @base is also set. (Since 2.8)
#
# @backing-file: The backing file string to write into the top
-# image. This filename is not validated.
+# image. This filename is not validated.
#
-# If a pathname string is such that it cannot be
-# resolved by QEMU, that means that subsequent QMP or
-# HMP commands must use node-names for the image in
-# question, as filename lookup methods will fail.
+# If a pathname string is such that it cannot be
+# resolved by QEMU, that means that subsequent QMP or
+# HMP commands must use node-names for the image in
+# question, as filename lookup methods will fail.
#
-# If not specified, QEMU will automatically determine
-# the backing file string to use, or error out if there
-# is no obvious choice. Care should be taken when
-# specifying the string, to specify a valid filename or
-# protocol.
-# (Since 2.1)
+# If not specified, QEMU will automatically determine
+# the backing file string to use, or error out if there
+# is no obvious choice. Care should be taken when
+# specifying the string, to specify a valid filename or
+# protocol.
+# (Since 2.1)
#
-# @speed: the maximum speed, in bytes per second
+# @speed: the maximum speed, in bytes per second
#
# @on-error: the action to take on an error (default report).
# 'stop' and 'enospc' can only be used if the block device
@@ -2653,8 +2653,8 @@
# the name of the parameter), but since QEMU 2.7 it can have
# other values.
#
-# @speed: the maximum speed, in bytes per second, or 0 for unlimited.
-# Defaults to 0.
+# @speed: the maximum speed, in bytes per second, or 0 for unlimited.
+# Defaults to 0.
#
# Returns: Nothing on success
# If no background operation is active on this device, DeviceNotActive
@@ -2820,8 +2820,8 @@
#
# Determines how to handle discard requests.
#
-# @ignore: Ignore the request
-# @unmap: Forward as an unmap request
+# @ignore: Ignore the request
+# @unmap: Forward as an unmap request
#
# Since: 2.9
##
@@ -2834,10 +2834,10 @@
# Describes the operation mode for the automatic conversion of plain
# zero writes by the OS to driver specific optimized zero write commands.
#
-# @off: Disabled (default)
-# @on: Enabled
-# @unmap: Enabled and even try to unmap blocks if possible. This requires
-# also that @BlockdevDiscardOptions is set to unmap for this device.
+# @off: Disabled (default)
+# @on: Enabled
+# @unmap: Enabled and even try to unmap blocks if possible. This requires
+# also that @BlockdevDiscardOptions is set to unmap for this device.
#
# Since: 2.1
##
@@ -2849,9 +2849,9 @@
#
# Selects the AIO backend to handle I/O requests
#
-# @threads: Use qemu's thread pool
-# @native: Use native AIO backend (only Linux and Windows)
-# @io_uring: Use linux io_uring (since 5.0)
+# @threads: Use qemu's thread pool
+# @native: Use native AIO backend (only Linux and Windows)
+# @io_uring: Use linux io_uring (since 5.0)
#
# Since: 2.9
##
@@ -2864,10 +2864,10 @@
#
# Includes cache-related options for block devices
#
-# @direct: enables use of O_DIRECT (bypass the host page cache;
-# default: false)
-# @no-flush: ignore any flush requests for the device (default:
-# false)
+# @direct: enables use of O_DIRECT (bypass the host page cache;
+# default: false)
+# @no-flush: ignore any flush requests for the device (default:
+# false)
#
# Since: 2.9
##
@@ -2905,18 +2905,18 @@
#
# Driver specific block device options for the file backend.
#
-# @filename: path to the image file
-# @pr-manager: the id for the object that will handle persistent reservations
-# for this device (default: none, forward the commands via SG_IO;
-# since 2.11)
-# @aio: AIO backend (default: threads) (since: 2.8)
-# @locking: whether to enable file locking. If set to 'auto', only enable
-# when Open File Descriptor (OFD) locking API is available
-# (default: auto, since 2.10)
-# @drop-cache: invalidate page cache during live migration. This prevents
-# stale data on the migration destination with cache.direct=off.
-# Currently only supported on Linux hosts.
-# (default: on, since: 4.0)
+# @filename: path to the image file
+# @pr-manager: the id for the object that will handle persistent reservations
+# for this device (default: none, forward the commands via SG_IO;
+# since 2.11)
+# @aio: AIO backend (default: threads) (since: 2.8)
+# @locking: whether to enable file locking. If set to 'auto', only enable
+# when Open File Descriptor (OFD) locking API is available
+# (default: auto, since 2.10)
+# @drop-cache: invalidate page cache during live migration. This prevents
+# stale data on the migration destination with cache.direct=off.
+# Currently only supported on Linux hosts.
+# (default: on, since: 4.0)
# @x-check-cache-dropped: whether to check that page cache was dropped on live
# migration. May cause noticeable delays if the image
# file is large, do not use in production.
@@ -2949,7 +2949,7 @@
#
# Driver specific block device options for the null backend.
#
-# @size: size of the device in bytes.
+# @size: size of the device in bytes.
# @latency-ns: emulated latency (in nanoseconds) in processing
# requests. Default to zero which completes requests immediately.
# (Since 2.4)
@@ -2966,8 +2966,8 @@
#
# Driver specific block device options for the NVMe backend.
#
-# @device: PCI controller address of the NVMe device in
-# format hhhh:bb:ss.f (host:bus:slot.function)
+# @device: PCI controller address of the NVMe device in
+# format hhhh:bb:ss.f (host:bus:slot.function)
# @namespace: namespace number of the device, starting from 1.
#
# Note that the PCI @device must have been unbound from any host
@@ -2983,15 +2983,15 @@
#
# Driver specific block device options for the vvfat protocol.
#
-# @dir: directory to be exported as FAT image
-# @fat-type: FAT type: 12, 16 or 32
-# @floppy: whether to export a floppy image (true) or
-# partitioned hard disk (false; default)
-# @label: set the volume label, limited to 11 bytes. FAT16 and
-# FAT32 traditionally have some restrictions on labels, which are
-# ignored by most operating systems. Defaults to "QEMU VVFAT".
-# (since 2.4)
-# @rw: whether to allow write operations (default: false)
+# @dir: directory to be exported as FAT image
+# @fat-type: FAT type: 12, 16 or 32
+# @floppy: whether to export a floppy image (true) or
+# partitioned hard disk (false; default)
+# @label: set the volume label, limited to 11 bytes. FAT16 and
+# FAT32 traditionally have some restrictions on labels, which are
+# ignored by most operating systems. Defaults to "QEMU VVFAT".
+# (since 2.4)
+# @rw: whether to allow write operations (default: false)
#
# Since: 2.9
##
@@ -3005,7 +3005,7 @@
# Driver specific block device options for image format that have no option
# besides their data source.
#
-# @file: reference to or definition of the data source block device
+# @file: reference to or definition of the data source block device
#
# Since: 2.9
##
@@ -3034,9 +3034,9 @@
# Driver specific block device options for image format that have no option
# besides their data source and an optional backing file.
#
-# @backing: reference to or definition of the backing file block
-# device, null disables the backing file entirely.
-# Defaults to the backing file stored the image file.
+# @backing: reference to or definition of the backing file block
+# device, null disables the backing file entirely.
+# Defaults to the backing file stored the image file.
#
# Since: 2.9
##
@@ -3049,15 +3049,15 @@
#
# General overlap check modes.
#
-# @none: Do not perform any checks
+# @none: Do not perform any checks
#
-# @constant: Perform only checks which can be done in constant time and
-# without reading anything from disk
+# @constant: Perform only checks which can be done in constant time and
+# without reading anything from disk
#
-# @cached: Perform only checks which can be done without reading anything
-# from disk
+# @cached: Perform only checks which can be done without reading anything
+# from disk
#
-# @all: Perform all available overlap checks
+# @all: Perform all available overlap checks
#
# Since: 2.9
##
@@ -3096,10 +3096,10 @@
# Specifies which metadata structures should be guarded against unintended
# overwriting.
#
-# @flags: set of flags for separate specification of each metadata structure
-# type
+# @flags: set of flags for separate specification of each metadata structure
+# type
#
-# @mode: named mode which chooses a specific set of flags
+# @mode: named mode which chooses a specific set of flags
#
# Since: 2.9
##
@@ -3132,9 +3132,9 @@
#
# Driver specific block device options for qcow.
#
-# @encrypt: Image decryption options. Mandatory for
-# encrypted images, except when doing a metadata-only
-# probe of the image.
+# @encrypt: Image decryption options. Mandatory for
+# encrypted images, except when doing a metadata-only
+# probe of the image.
#
# Since: 2.10
##
@@ -3169,51 +3169,51 @@
#
# Driver specific block device options for qcow2.
#
-# @lazy-refcounts: whether to enable the lazy refcounts
-# feature (default is taken from the image file)
+# @lazy-refcounts: whether to enable the lazy refcounts
+# feature (default is taken from the image file)
#
-# @pass-discard-request: whether discard requests to the qcow2
-# device should be forwarded to the data source
+# @pass-discard-request: whether discard requests to the qcow2
+# device should be forwarded to the data source
#
# @pass-discard-snapshot: whether discard requests for the data source
# should be issued when a snapshot operation (e.g.
# deleting a snapshot) frees clusters in the qcow2 file
#
-# @pass-discard-other: whether discard requests for the data source
-# should be issued on other occasions where a cluster
-# gets freed
+# @pass-discard-other: whether discard requests for the data source
+# should be issued on other occasions where a cluster
+# gets freed
#
-# @overlap-check: which overlap checks to perform for writes
-# to the image, defaults to 'cached' (since 2.2)
+# @overlap-check: which overlap checks to perform for writes
+# to the image, defaults to 'cached' (since 2.2)
#
-# @cache-size: the maximum total size of the L2 table and
-# refcount block caches in bytes (since 2.2)
+# @cache-size: the maximum total size of the L2 table and
+# refcount block caches in bytes (since 2.2)
#
-# @l2-cache-size: the maximum size of the L2 table cache in
-# bytes (since 2.2)
+# @l2-cache-size: the maximum size of the L2 table cache in
+# bytes (since 2.2)
#
-# @l2-cache-entry-size: the size of each entry in the L2 cache in
-# bytes. It must be a power of two between 512
-# and the cluster size. The default value is
-# the cluster size (since 2.12)
+# @l2-cache-entry-size: the size of each entry in the L2 cache in
+# bytes. It must be a power of two between 512
+# and the cluster size. The default value is
+# the cluster size (since 2.12)
#
-# @refcount-cache-size: the maximum size of the refcount block cache
-# in bytes (since 2.2)
+# @refcount-cache-size: the maximum size of the refcount block cache
+# in bytes (since 2.2)
#
-# @cache-clean-interval: clean unused entries in the L2 and refcount
-# caches. The interval is in seconds. The default value
-# is 600 on supporting platforms, and 0 on other
-# platforms. 0 disables this feature. (since 2.5)
+# @cache-clean-interval: clean unused entries in the L2 and refcount
+# caches. The interval is in seconds. The default value
+# is 600 on supporting platforms, and 0 on other
+# platforms. 0 disables this feature. (since 2.5)
#
-# @encrypt: Image decryption options. Mandatory for
-# encrypted images, except when doing a metadata-only
-# probe of the image. (since 2.10)
+# @encrypt: Image decryption options. Mandatory for
+# encrypted images, except when doing a metadata-only
+# probe of the image. (since 2.10)
#
-# @data-file: reference to or definition of the external data file.
-# This may only be specified for images that require an
-# external data file. If it is not specified for such
-# an image, the data file name is loaded from the image
-# file. (since 4.0)
+# @data-file: reference to or definition of the external data file.
+# This may only be specified for images that require an
+# external data file. If it is not specified for such
+# an image, the data file name is loaded from the image
+# file. (since 4.0)
#
# Since: 2.9
##
@@ -3304,8 +3304,8 @@
#
# Trigger events supported by blkdebug.
#
-# @l1_shrink_write_table: write zeros to the l1 table to shrink image.
-# (since 2.11)
+# @l1_shrink_write_table: write zeros to the l1 table to shrink image.
+# (since 2.11)
#
# @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11)
#
@@ -3363,25 +3363,25 @@
#
# Describes a single error injection for blkdebug.
#
-# @event: trigger event
+# @event: trigger event
#
-# @state: the state identifier blkdebug needs to be in to
-# actually trigger the event; defaults to "any"
+# @state: the state identifier blkdebug needs to be in to
+# actually trigger the event; defaults to "any"
#
-# @iotype: the type of I/O operations on which this error should
-# be injected; defaults to "all read, write,
-# write-zeroes, discard, and flush operations"
-# (since: 4.1)
+# @iotype: the type of I/O operations on which this error should
+# be injected; defaults to "all read, write,
+# write-zeroes, discard, and flush operations"
+# (since: 4.1)
#
-# @errno: error identifier (errno) to be returned; defaults to
-# EIO
+# @errno: error identifier (errno) to be returned; defaults to
+# EIO
#
-# @sector: specifies the sector index which has to be affected
-# in order to actually trigger the event; defaults to "any
-# sector"
+# @sector: specifies the sector index which has to be affected
+# in order to actually trigger the event; defaults to "any
+# sector"
#
-# @once: disables further events after this one has been
-# triggered; defaults to false
+# @once: disables further events after this one has been
+# triggered; defaults to false
#
# @immediately: fail immediately; defaults to false
#
@@ -3401,13 +3401,13 @@
#
# Describes a single state-change event for blkdebug.
#
-# @event: trigger event
+# @event: trigger event
#
-# @state: the current state identifier blkdebug needs to be in;
-# defaults to "any"
+# @state: the current state identifier blkdebug needs to be in;
+# defaults to "any"
#
-# @new_state: the state identifier blkdebug is supposed to assume if
-# this event is triggered
+# @new_state: the state identifier blkdebug is supposed to assume if
+# this event is triggered
#
# Since: 2.9
##
@@ -3421,41 +3421,41 @@
#
# Driver specific block device options for blkdebug.
#
-# @image: underlying raw block device (or image file)
+# @image: underlying raw block device (or image file)
#
-# @config: filename of the configuration file
+# @config: filename of the configuration file
#
-# @align: required alignment for requests in bytes, must be
-# positive power of 2, or 0 for default
+# @align: required alignment for requests in bytes, must be
+# positive power of 2, or 0 for default
#
-# @max-transfer: maximum size for I/O transfers in bytes, must be
-# positive multiple of @align and of the underlying
-# file's request alignment (but need not be a power of
-# 2), or 0 for default (since 2.10)
+# @max-transfer: maximum size for I/O transfers in bytes, must be
+# positive multiple of @align and of the underlying
+# file's request alignment (but need not be a power of
+# 2), or 0 for default (since 2.10)
#
-# @opt-write-zero: preferred alignment for write zero requests in bytes,
-# must be positive multiple of @align and of the
-# underlying file's request alignment (but need not be a
-# power of 2), or 0 for default (since 2.10)
+# @opt-write-zero: preferred alignment for write zero requests in bytes,
+# must be positive multiple of @align and of the
+# underlying file's request alignment (but need not be a
+# power of 2), or 0 for default (since 2.10)
#
-# @max-write-zero: maximum size for write zero requests in bytes, must be
-# positive multiple of @align, of @opt-write-zero, and of
-# the underlying file's request alignment (but need not
-# be a power of 2), or 0 for default (since 2.10)
+# @max-write-zero: maximum size for write zero requests in bytes, must be
+# positive multiple of @align, of @opt-write-zero, and of
+# the underlying file's request alignment (but need not
+# be a power of 2), or 0 for default (since 2.10)
#
-# @opt-discard: preferred alignment for discard requests in bytes, must
-# be positive multiple of @align and of the underlying
-# file's request alignment (but need not be a power of
-# 2), or 0 for default (since 2.10)
+# @opt-discard: preferred alignment for discard requests in bytes, must
+# be positive multiple of @align and of the underlying
+# file's request alignment (but need not be a power of
+# 2), or 0 for default (since 2.10)
#
-# @max-discard: maximum size for discard requests in bytes, must be
-# positive multiple of @align, of @opt-discard, and of
-# the underlying file's request alignment (but need not
-# be a power of 2), or 0 for default (since 2.10)
+# @max-discard: maximum size for discard requests in bytes, must be
+# positive multiple of @align, of @opt-discard, and of
+# the underlying file's request alignment (but need not
+# be a power of 2), or 0 for default (since 2.10)
#
-# @inject-error: array of error injection descriptions
+# @inject-error: array of error injection descriptions
#
-# @set-state: array of state-change descriptions
+# @set-state: array of state-change descriptions
#
# @take-child-perms: Permissions to take on @image in addition to what
# is necessary anyway (which depends on how the
@@ -3485,14 +3485,14 @@
#
# Driver specific block device options for blklogwrites.
#
-# @file: block device
+# @file: block device
#
-# @log: block device used to log writes to @file
+# @log: block device used to log writes to @file
#
# @log-sector-size: sector size used in logging writes to @file, determines
# granularity of offsets and sizes of writes (default: 512)
#
-# @log-append: append to an existing log (default: false)
+# @log-append: append to an existing log (default: false)
#
# @log-super-update-interval: interval of write requests after which the log
# super block is updated to disk (default: 4096)
@@ -3511,9 +3511,9 @@
#
# Driver specific block device options for blkverify.
#
-# @test: block device to be tested
+# @test: block device to be tested
#
-# @raw: raw image used for verification
+# @raw: raw image used for verification
#
# Since: 2.9
##
@@ -3526,7 +3526,7 @@
#
# Driver specific block device options for blkreplay.
#
-# @image: disk image which should be controlled with blkreplay
+# @image: disk image which should be controlled with blkreplay
#
# Since: 4.2
##
@@ -3551,10 +3551,10 @@
#
# Driver specific block device options for Quorum
#
-# @blkverify: true if the driver must print content mismatch
+# @blkverify: true if the driver must print content mismatch
# set to false by default
#
-# @children: the children block devices to use
+# @children: the children block devices to use
#
# @vote-threshold: the vote limit under which a read will fail
#
@@ -3578,16 +3578,16 @@
#
# Driver specific block device options for Gluster
#
-# @volume: name of gluster volume where VM image resides
+# @volume: name of gluster volume where VM image resides
#
-# @path: absolute path to image file in gluster volume
+# @path: absolute path to image file in gluster volume
#
-# @server: gluster servers description
+# @server: gluster servers description
#
-# @debug: libgfapi log level (default '4' which is Error)
-# (Since 2.8)
+# @debug: libgfapi log level (default '4' which is Error)
+# (Since 2.8)
#
-# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
+# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
#
# Since: 2.9
##
@@ -3622,30 +3622,30 @@
##
# @BlockdevOptionsIscsi:
#
-# @transport: The iscsi transport type
+# @transport: The iscsi transport type
#
-# @portal: The address of the iscsi portal
+# @portal: The address of the iscsi portal
#
-# @target: The target iqn name
+# @target: The target iqn name
#
-# @lun: LUN to connect to. Defaults to 0.
+# @lun: LUN to connect to. Defaults to 0.
#
-# @user: User name to log in with. If omitted, no CHAP
-# authentication is performed.
+# @user: User name to log in with. If omitted, no CHAP
+# authentication is performed.
#
# @password-secret: The ID of a QCryptoSecret object providing
# the password for the login. This option is required if
# @user is specified.
#
-# @initiator-name: The iqn name we want to identify to the target
-# as. If this option is not specified, an initiator name is
-# generated automatically.
+# @initiator-name: The iqn name we want to identify to the target
+# as. If this option is not specified, an initiator name is
+# generated automatically.
#
-# @header-digest: The desired header digest. Defaults to
-# none-crc32c.
+# @header-digest: The desired header digest. Defaults to
+# none-crc32c.
#
-# @timeout: Timeout in seconds after which a request will
-# timeout. 0 means no timeout and is the default.
+# @timeout: Timeout in seconds after which a request will
+# timeout. 0 means no timeout and is the default.
#
# Driver specific block device options for iscsi
#
@@ -3674,29 +3674,29 @@
##
# @BlockdevOptionsRbd:
#
-# @pool: Ceph pool name.
+# @pool: Ceph pool name.
#
-# @image: Image name in the Ceph pool.
+# @image: Image name in the Ceph pool.
#
-# @conf: path to Ceph configuration file. Values
-# in the configuration file will be overridden by
-# options specified via QAPI.
+# @conf: path to Ceph configuration file. Values
+# in the configuration file will be overridden by
+# options specified via QAPI.
#
-# @snapshot: Ceph snapshot name.
+# @snapshot: Ceph snapshot name.
#
-# @user: Ceph id name.
+# @user: Ceph id name.
#
# @auth-client-required: Acceptable authentication modes.
-# This maps to Ceph configuration option
-# "auth_client_required". (Since 3.0)
+# This maps to Ceph configuration option
+# "auth_client_required". (Since 3.0)
#
-# @key-secret: ID of a QCryptoSecret object providing a key
-# for cephx authentication.
-# This maps to Ceph configuration option
-# "key". (Since 3.0)
+# @key-secret: ID of a QCryptoSecret object providing a key
+# for cephx authentication.
+# This maps to Ceph configuration option
+# "key". (Since 3.0)
#
-# @server: Monitor host address and port. This maps
-# to the "mon_host" Ceph option.
+# @server: Monitor host address and port. This maps
+# to the "mon_host" Ceph option.
#
# Since: 2.9
##
@@ -3715,10 +3715,10 @@
#
# Driver specific block device options for sheepdog
#
-# @vdi: Virtual disk image name
-# @server: The Sheepdog server to connect to
-# @snap-id: Snapshot ID
-# @tag: Snapshot tag name
+# @vdi: Virtual disk image name
+# @server: The Sheepdog server to connect to
+# @snap-id: Snapshot ID
+# @tag: Snapshot tag name
#
# Only one of @snap-id and @tag may be present.
#
@@ -3768,7 +3768,7 @@
#
# An enumeration of NFS transport types
#
-# @inet: TCP transport
+# @inet: TCP transport
#
# Since: 2.9
##
@@ -3780,9 +3780,9 @@
#
# Captures the address of the socket
#
-# @type: transport type used for NFS (only TCP supported)
+# @type: transport type used for NFS (only TCP supported)
#
-# @host: host address for NFS server
+# @host: host address for NFS server
#
# Since: 2.9
##
@@ -3795,29 +3795,29 @@
#
# Driver specific block device option for NFS
#
-# @server: host address
+# @server: host address
#
-# @path: path of the image on the host
+# @path: path of the image on the host
#
-# @user: UID value to use when talking to the
-# server (defaults to 65534 on Windows and getuid()
-# on unix)
+# @user: UID value to use when talking to the
+# server (defaults to 65534 on Windows and getuid()
+# on unix)
#
-# @group: GID value to use when talking to the
-# server (defaults to 65534 on Windows and getgid()
-# in unix)
+# @group: GID value to use when talking to the
+# server (defaults to 65534 on Windows and getgid()
+# in unix)
#
-# @tcp-syn-count: number of SYNs during the session
-# establishment (defaults to libnfs default)
+# @tcp-syn-count: number of SYNs during the session
+# establishment (defaults to libnfs default)
#
-# @readahead-size: set the readahead size in bytes (defaults
-# to libnfs default)
+# @readahead-size: set the readahead size in bytes (defaults
+# to libnfs default)
#
-# @page-cache-size: set the pagecache size in bytes (defaults
-# to libnfs default)
+# @page-cache-size: set the pagecache size in bytes (defaults
+# to libnfs default)
#
-# @debug: set the NFS debug level (max 2) (defaults
-# to libnfs default)
+# @debug: set the NFS debug level (max 2) (defaults
+# to libnfs default)
#
# Since: 2.9
##
@@ -3837,22 +3837,22 @@
# Driver specific block device options shared by all protocols supported by the
# curl backend.
#
-# @url: URL of the image file
+# @url: URL of the image file
#
-# @readahead: Size of the read-ahead cache; must be a multiple of
-# 512 (defaults to 256 kB)
+# @readahead: Size of the read-ahead cache; must be a multiple of
+# 512 (defaults to 256 kB)
#
-# @timeout: Timeout for connections, in seconds (defaults to 5)
+# @timeout: Timeout for connections, in seconds (defaults to 5)
#
-# @username: Username for authentication (defaults to none)
+# @username: Username for authentication (defaults to none)
#
-# @password-secret: ID of a QCryptoSecret object providing a password
-# for authentication (defaults to no password)
+# @password-secret: ID of a QCryptoSecret object providing a password
+# for authentication (defaults to no password)
#
-# @proxy-username: Username for proxy authentication (defaults to none)
+# @proxy-username: Username for proxy authentication (defaults to none)
#
-# @proxy-password-secret: ID of a QCryptoSecret object providing a password
-# for proxy authentication (defaults to no password)
+# @proxy-password-secret: ID of a QCryptoSecret object providing a password
+# for proxy authentication (defaults to no password)
#
# Since: 2.9
##
@@ -3871,9 +3871,9 @@
# Driver specific block device options for HTTP connections over the curl
# backend. URLs must start with "http://".
#
-# @cookie: List of cookies to set; format is
-# "name1=content1; name2=content2;" as explained by
-# CURLOPT_COOKIE(3). Defaults to no cookies.
+# @cookie: List of cookies to set; format is
+# "name1=content1; name2=content2;" as explained by
+# CURLOPT_COOKIE(3). Defaults to no cookies.
#
# @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
# secure way. See @cookie for the format. (since 2.10)
@@ -3891,12 +3891,12 @@
# Driver specific block device options for HTTPS connections over the curl
# backend. URLs must start with "https://".
#
-# @cookie: List of cookies to set; format is
-# "name1=content1; name2=content2;" as explained by
-# CURLOPT_COOKIE(3). Defaults to no cookies.
+# @cookie: List of cookies to set; format is
+# "name1=content1; name2=content2;" as explained by
+# CURLOPT_COOKIE(3). Defaults to no cookies.
#
-# @sslverify: Whether to verify the SSL certificate's validity (defaults to
-# true)
+# @sslverify: Whether to verify the SSL certificate's validity (defaults to
+# true)
#
# @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
# secure way. See @cookie for the format. (since 2.10)
@@ -3927,8 +3927,8 @@
# Driver specific block device options for FTPS connections over the curl
# backend. URLs must start with "ftps://".
#
-# @sslverify: Whether to verify the SSL certificate's validity (defaults to
-# true)
+# @sslverify: Whether to verify the SSL certificate's validity (defaults to
+# true)
#
# Since: 2.9
##
@@ -3941,11 +3941,11 @@
#
# Driver specific block device options for NBD.
#
-# @server: NBD server address
+# @server: NBD server address
#
-# @export: export name
+# @export: export name
#
-# @tls-creds: TLS credentials ID
+# @tls-creds: TLS credentials ID
#
# @x-dirty-bitmap: A "qemu:dirty-bitmap:NAME" string to query in place of
# traditional "base:allocation" block status (see
@@ -3973,8 +3973,8 @@
#
# Driver specific block device options for the raw driver.
#
-# @offset: position where the block device starts
-# @size: the assumed size of the device
+# @offset: position where the block device starts
+# @size: the assumed size of the device
#
# Since: 2.9
##
@@ -3987,9 +3987,9 @@
#
# Driver specific block device options for VxHS
#
-# @vdisk-id: UUID of VxHS volume
-# @server: vxhs server IP, port
-# @tls-creds: TLS credentials ID
+# @vdisk-id: UUID of VxHS volume
+# @server: vxhs server IP, port
+# @tls-creds: TLS credentials ID
#
# Since: 2.10
##
@@ -4003,9 +4003,9 @@
#
# Driver specific block device options for the throttle driver
#
-# @throttle-group: the name of the throttle-group object to use. It
-# must already exist.
-# @file: reference to or definition of the data source block device
+# @throttle-group: the name of the throttle-group object to use. It
+# must already exist.
+# @file: reference to or definition of the data source block device
# Since: 2.11
##
{ 'struct': 'BlockdevOptionsThrottle',
@@ -4018,19 +4018,19 @@
# Options for creating a block device. Many options are available for all
# block devices, independent of the block driver:
#
-# @driver: block driver name
-# @node-name: the node name of the new node (Since 2.0).
-# This option is required on the top level of blockdev-add.
-# Valid node names start with an alphabetic character and may
-# contain only alphanumeric characters, '-', '.' and '_'. Their
-# maximum length is 31 characters.
-# @discard: discard-related options (default: ignore)
-# @cache: cache-related options
-# @read-only: whether the block device should be read-only (default: false).
-# Note that some block drivers support only read-only access,
-# either generally or in certain configurations. In this case,
-# the default value does not work and the option must be
-# specified explicitly.
+# @driver: block driver name
+# @node-name: the node name of the new node (Since 2.0).
+# This option is required on the top level of blockdev-add.
+# Valid node names start with an alphabetic character and may
+# contain only alphanumeric characters, '-', '.' and '_'. Their
+# maximum length is 31 characters.
+# @discard: discard-related options (default: ignore)
+# @cache: cache-related options
+# @read-only: whether the block device should be read-only (default: false).
+# Note that some block drivers support only read-only access,
+# either generally or in certain configurations. In this case,
+# the default value does not work and the option must be
+# specified explicitly.
# @auto-read-only: if true and @read-only is false, QEMU may automatically
# decide not to open the image read-write as requested, but
# fall back to read-only instead (and switch between the modes
@@ -4039,8 +4039,8 @@
# (default: false, since 3.1)
# @detect-zeroes: detect and optimize zero writes (Since 2.1)
# (default: off)
-# @force-share: force share all permission on added nodes.
-# Requires read-only=true. (Since 2.10)
+# @force-share: force share all permission on added nodes.
+# Requires read-only=true. (Since 2.10)
#
# Remaining options are determined by the block driver.
#
@@ -4106,8 +4106,8 @@
#
# Reference to a block device.
#
-# @definition: defines a new block device inline
-# @reference: references the ID of an existing block device
+# @definition: defines a new block device inline
+# @reference: references the ID of an existing block device
#
# Since: 2.9
##
@@ -4120,11 +4120,11 @@
#
# Reference to a block device.
#
-# @definition: defines a new block device inline
-# @reference: references the ID of an existing block device.
-# An empty string means that no block device should
-# be referenced. Deprecated; use null instead.
-# @null: No block device should be referenced (since 2.10)
+# @definition: defines a new block device inline
+# @reference: references the ID of an existing block device.
+# An empty string means that no block device should
+# be referenced. Deprecated; use null instead.
+# @null: No block device should be referenced (since 2.10)
#
# Since: 2.9
##
@@ -4765,12 +4765,12 @@
#
# @device: Block device name (deprecated, use @id instead)
#
-# @id: The name or QOM path of the guest device (since: 2.8)
+# @id: The name or QOM path of the guest device (since: 2.8)
#
-# @force: if false (the default), an eject request will be sent to
-# the guest if it has locked the tray (and the tray will not be opened
-# immediately); if true, the tray will be opened regardless of whether
-# it is locked
+# @force: if false (the default), an eject request will be sent to
+# the guest if it has locked the tray (and the tray will not be opened
+# immediately); if true, the tray will be opened regardless of whether
+# it is locked
#
# Since: 2.5
#
@@ -4803,9 +4803,9 @@
#
# If the tray was already closed before, this will be a no-op.
#
-# @device: Block device name (deprecated, use @id instead)
+# @device: Block device name (deprecated, use @id instead)
#
-# @id: The name or QOM path of the guest device (since: 2.8)
+# @id: The name or QOM path of the guest device (since: 2.8)
#
# Since: 2.5
#
@@ -4837,7 +4837,7 @@
#
# If the tray is open and there is no medium inserted, this will be a no-op.
#
-# @id: The name or QOM path of the guest device
+# @id: The name or QOM path of the guest device
#
# Since: 2.12
#
@@ -4877,7 +4877,7 @@
# device's tray must currently be open (unless there is no attached guest
# device) and there must be no medium inserted already.
#
-# @id: The name or QOM path of the guest device
+# @id: The name or QOM path of the guest device
#
# @node-name: name of a node in the block driver state graph
#
@@ -4911,11 +4911,11 @@
# Specifies the new read-only mode of a block device subject to the
# @blockdev-change-medium command.
#
-# @retain: Retains the current read-only mode
+# @retain: Retains the current read-only mode
#
-# @read-only: Makes the device read-only
+# @read-only: Makes the device read-only
#
-# @read-write: Makes the device writable
+# @read-write: Makes the device writable
#
# Since: 2.3
#
@@ -4932,18 +4932,18 @@
# combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium
# and blockdev-close-tray).
#
-# @device: Block device name (deprecated, use @id instead)
+# @device: Block device name (deprecated, use @id instead)
#
-# @id: The name or QOM path of the guest device
-# (since: 2.8)
+# @id: The name or QOM path of the guest device
+# (since: 2.8)
#
-# @filename: filename of the new image to be loaded
+# @filename: filename of the new image to be loaded
#
-# @format: format to open the new image with (defaults to
-# the probed format)
+# @format: format to open the new image with (defaults to
+# the probed format)
#
-# @read-only-mode: change the read-only mode of the device; defaults
-# to 'retain'
+# @read-only-mode: change the read-only mode of the device; defaults
+# to 'retain'
#
# Since: 2.5
#
@@ -5028,8 +5028,8 @@
# the access size
#
# @fatal: if set, the image is marked corrupt and therefore unusable after this
-# event and must be repaired (Since 2.2; before, every
-# BLOCK_IMAGE_CORRUPTED event was fatal)
+# event and must be repaired (Since 2.2; before, every
+# BLOCK_IMAGE_CORRUPTED event was fatal)
#
# Note: If action is "stop", a STOP event will eventually follow the
# BLOCK_IO_ERROR event.
@@ -5077,10 +5077,10 @@
#
# @reason: human readable string describing the error cause.
# (This field is a debugging aid for humans, it should not
-# be parsed by applications) (since: 2.2)
+# be parsed by applications) (since: 2.2)
#
# Note: If action is "stop", a STOP event will eventually follow the
-# BLOCK_IO_ERROR event
+# BLOCK_IO_ERROR event
#
# Since: 0.13.0
#
@@ -5222,7 +5222,7 @@
# @speed: rate limit, bytes per second
#
# Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
-# event
+# event
#
# Since: 1.3
#
@@ -5356,15 +5356,15 @@
# @node: the name of the node that will be added.
#
# Note: this command is experimental, and its API is not stable. It
-# does not support all kinds of operations, all kinds of children, nor
-# all block drivers.
+# does not support all kinds of operations, all kinds of children, nor
+# all block drivers.
#
-# FIXME Removing children from a quorum node means introducing gaps in the
-# child indices. This cannot be represented in the 'children' list of
-# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().
+# FIXME Removing children from a quorum node means introducing gaps in the
+# child indices. This cannot be represented in the 'children' list of
+# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().
#
-# Warning: The data in a new quorum child MUST be consistent with that of
-# the rest of the array.
+# Warning: The data in a new quorum child MUST be consistent with that of
+# the rest of the array.
#
# Since: 2.7
#
@@ -5411,7 +5411,7 @@
# is already attached
#
# Note: this command is experimental and intended for test cases that need
-# control over IOThreads only.
+# control over IOThreads only.
#
# Since: 2.12
#
diff --git a/qapi/block.json b/qapi/block.json
index 145c268bb64..905297bab2e 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -190,12 +190,12 @@
#
# Ejects a device from a removable drive.
#
-# @device: Block device name (deprecated, use @id instead)
+# @device: Block device name (deprecated, use @id instead)
#
-# @id: The name or QOM path of the guest device (since: 2.8)
+# @id: The name or QOM path of the guest device (since: 2.8)
#
-# @force: If true, eject regardless of whether the drive is locked.
-# If not specified, the default value is false.
+# @force: If true, eject regardless of whether the drive is locked.
+# If not specified, the default value is false.
#
# Returns: Nothing on success
#
@@ -251,7 +251,7 @@
# export name. (Since 2.12)
#
# @writable: Whether clients should be able to write to the device via the
-# NBD connection (default false).
+# NBD connection (default false).
# @bitmap: Also export the dirty bitmap reachable from @device, so the
# NBD client can use NBD_OPT_SET_META_CONTEXT with
@@ -278,10 +278,10 @@
# Potential additional modes to be added in the future:
#
# hide: Just hide export from new clients, leave existing connections as is.
-# Remove export after all clients are disconnected.
+# Remove export after all clients are disconnected.
#
# soft: Hide export from new clients, answer with ESHUTDOWN for all further
-# requests from existing clients.
+# requests from existing clients.
#
# Since: 2.12
##
diff --git a/qapi/char.json b/qapi/char.json
index a6e81ac7bc6..8a9f1e75097 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -262,11 +262,11 @@
# @tn3270: enable tn3270 protocol on server
# sockets (default: false) (Since: 2.10)
# @websocket: enable websocket protocol on server
-# sockets (default: false) (Since: 3.1)
+# sockets (default: false) (Since: 3.1)
# @reconnect: For a client socket, if a socket is disconnected,
-# then attempt a reconnect after the given number of seconds.
-# Setting this to zero disables this function. (default: 0)
-# (Since: 2.2)
+# then attempt a reconnect after the given number of seconds.
+# Setting this to zero disables this function. (default: 0)
+# (Since: 2.2)
#
# Since: 1.4
##
diff --git a/qapi/dump.json b/qapi/dump.json
index 2b35409a7b2..a1eed7b15c5 100644
--- a/qapi/dump.json
+++ b/qapi/dump.json
@@ -38,8 +38,8 @@
# using gdb to process the core file.
#
# IMPORTANT: this option can make QEMU allocate several gigabytes
-# of RAM. This can happen for a large guest, or a
-# malicious guest pretending to be large.
+# of RAM. This can happen for a large guest, or a
+# malicious guest pretending to be large.
#
# Also, paging=true has the following limitations:
#
diff --git a/qapi/introspect.json b/qapi/introspect.json
index 031a954fa9a..8756e7920e1 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -34,15 +34,15 @@
# alternate that includes the original type alongside something else.
#
# Returns: array of @SchemaInfo, where each element describes an
-# entity in the ABI: command, event, type, ...
+# entity in the ABI: command, event, type, ...
#
-# The order of the various SchemaInfo is unspecified; however, all
-# names are guaranteed to be unique (no name will be duplicated with
-# different meta-types).
+# The order of the various SchemaInfo is unspecified; however, all
+# names are guaranteed to be unique (no name will be duplicated with
+# different meta-types).
#
# Note: the QAPI schema is also used to help define *internal*
-# interfaces, by defining QAPI types. These are not part of the QMP
-# wire ABI, and therefore not returned by this command.
+# interfaces, by defining QAPI types. These are not part of the QMP
+# wire ABI, and therefore not returned by this command.
#
# Since: 2.5
##
diff --git a/qapi/job.json b/qapi/job.json
index a121b615fb0..5e658281f5c 100644
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -214,28 +214,28 @@
#
# Information about a job.
#
-# @id: The job identifier
+# @id: The job identifier
#
-# @type: The kind of job that is being performed
+# @type: The kind of job that is being performed
#
-# @status: Current job state/status
+# @status: Current job state/status
#
-# @current-progress: Progress made until now. The unit is arbitrary and the
-# value can only meaningfully be used for the ratio of
-# @current-progress to @total-progress. The value is
-# monotonically increasing.
+# @current-progress: Progress made until now. The unit is arbitrary and the
+# value can only meaningfully be used for the ratio of
+# @current-progress to @total-progress. The value is
+# monotonically increasing.
#
-# @total-progress: Estimated @current-progress value at the completion of
-# the job. This value can arbitrarily change while the
-# job is running, in both directions.
+# @total-progress: Estimated @current-progress value at the completion of
+# the job. This value can arbitrarily change while the
+# job is running, in both directions.
#
-# @error: If this field is present, the job failed; if it is
-# still missing in the CONCLUDED state, this indicates
-# successful completion.
+# @error: If this field is present, the job failed; if it is
+# still missing in the CONCLUDED state, this indicates
+# successful completion.
#
-# The value is a human-readable error message to describe
-# the reason for the job failure. It should not be parsed
-# by applications.
+# The value is a human-readable error message to describe
+# the reason for the job failure. It should not be parsed
+# by applications.
#
# Since: 3.0
##
diff --git a/qapi/machine-target.json b/qapi/machine-target.json
index 04623224720..f2c82949d80 100644
--- a/qapi/machine-target.json
+++ b/qapi/machine-target.json
@@ -40,13 +40,13 @@
# model details.
#
# Note: When a non-migration-safe CPU model is expanded in static mode, some
-# features enabled by the CPU model may be omitted, because they can't be
-# implemented by a static CPU model definition (e.g. cache info passthrough and
-# PMU passthrough in x86). If you need an accurate representation of the
-# features enabled by a non-migration-safe CPU model, use @full. If you need a
-# static representation that will keep ABI compatibility even when changing QEMU
-# version or machine-type, use @static (but keep in mind that some features may
-# be omitted).
+# features enabled by the CPU model may be omitted, because they can't be
+# implemented by a static CPU model definition (e.g. cache info passthrough and
+# PMU passthrough in x86). If you need an accurate representation of the
+# features enabled by a non-migration-safe CPU model, use @full. If you need a
+# static representation that will keep ABI compatibility even when changing QEMU
+# version or machine-type, use @static (but keep in mind that some features may
+# be omitted).
#
# Since: 2.8.0
##
@@ -148,7 +148,7 @@
# with wrong types.
#
# Note: this command isn't specific to s390x, but is only implemented
-# on this architecture currently.
+# on this architecture currently.
#
# Since: 2.8.0
##
@@ -191,7 +191,7 @@
# with wrong types.
#
# Note: this command isn't specific to s390x, but is only implemented
-# on this architecture currently.
+# on this architecture currently.
#
# Since: 2.8.0
##
diff --git a/qapi/machine.json b/qapi/machine.json
index b3d30bc8162..704b2b0fe31 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -680,7 +680,7 @@
# 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
#
# @none: None (no memory side cache in this proximity domain,
-# or cache write policy unknown)
+# or cache write policy unknown)
#
# @write-back: Write Back (WB)
#
@@ -706,7 +706,7 @@
# @level: the cache level described in this structure.
#
# @associativity: the cache associativity,
-# none/direct-mapped/complex(complex cache indexing).
+# none/direct-mapped/complex(complex cache indexing).
#
# @policy: the write policy, none/write-back/write-through.
#
@@ -823,10 +823,10 @@
# @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
#
# Note: currently there are 5 properties that could be present
-# but management should be prepared to pass through other
-# properties with device_add command to allow for future
-# interface extension. This also requires the filed names to be kept in
-# sync with the properties passed to -device/device_add.
+# but management should be prepared to pass through other
+# properties with device_add command to allow for future
+# interface extension. This also requires the filed names to be kept in
+# sync with the properties passed to -device/device_add.
#
# Since: 2.7
##
diff --git a/qapi/migration.json b/qapi/migration.json
index b7348d0c8bf..aa160e9e42d 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -28,22 +28,22 @@
# @normal-bytes: number of normal bytes sent (since 1.2)
#
# @dirty-pages-rate: number of pages dirtied by second by the
-# guest (since 1.3)
+# guest (since 1.3)
#
# @mbps: throughput in megabits/sec. (since 1.6)
#
# @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
#
# @postcopy-requests: The number of page requests received from the destination
-# (since 2.7)
+# (since 2.7)
#
# @page-size: The number of bytes per page for the various page-based
-# statistics (since 2.10)
+# statistics (since 2.10)
#
# @multifd-bytes: The number of bytes sent through multifd (since 3.0)
#
# @pages-per-second: the number of memory pages transferred per second
-# (Since 4.0)
+# (Since 4.0)
#
# Since: 0.14.0
##
@@ -131,7 +131,7 @@
# @pre-switchover: Paused before device serialisation. (since 2.11)
#
# @device: During device serialisation when pause-before-switchover is enabled
-# (since 2.11)
+# (since 2.11)
#
# @wait-unplug: wait for device unplug request by guest OS to be completed.
# (since 4.2)
@@ -167,41 +167,41 @@
# status is 'active' or 'completed' (since 1.2)
#
# @total-time: total amount of milliseconds since migration started.
-# If migration has ended, it returns the total migration
-# time. (since 1.2)
+# If migration has ended, it returns the total migration
+# time. (since 1.2)
#
# @downtime: only present when migration finishes correctly
-# total downtime in milliseconds for the guest.
-# (since 1.3)
+# total downtime in milliseconds for the guest.
+# (since 1.3)
#
# @expected-downtime: only present while migration is active
-# expected downtime in milliseconds for the guest in last walk
-# of the dirty bitmap. (since 1.3)
+# expected downtime in milliseconds for the guest in last walk
+# of the dirty bitmap. (since 1.3)
#
# @setup-time: amount of setup time in milliseconds _before_ the
-# iterations begin but _after_ the QMP command is issued. This is designed
-# to provide an accounting of any activities (such as RDMA pinning) which
-# may be expensive, but do not actually occur during the iterative
-# migration rounds themselves. (since 1.6)
+# iterations begin but _after_ the QMP command is issued. This is designed
+# to provide an accounting of any activities (such as RDMA pinning) which
+# may be expensive, but do not actually occur during the iterative
+# migration rounds themselves. (since 1.6)
#
# @cpu-throttle-percentage: percentage of time guest cpus are being
-# throttled during auto-converge. This is only present when auto-converge
-# has started throttling guest cpus. (Since 2.7)
+# throttled during auto-converge. This is only present when auto-converge
+# has started throttling guest cpus. (Since 2.7)
#
# @error-desc: the human readable error description string, when
# @status is 'failed'. Clients should not attempt to parse the
# error strings. (Since 2.7)
#
# @postcopy-blocktime: total time when all vCPU were blocked during postcopy
-# live migration. This is only present when the postcopy-blocktime
-# migration capability is enabled. (Since 3.0)
+# live migration. This is only present when the postcopy-blocktime
+# migration capability is enabled. (Since 3.0)
#
# @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU. This is
-# only present when the postcopy-blocktime migration capability
-# is enabled. (Since 3.0)
+# only present when the postcopy-blocktime migration capability
+# is enabled. (Since 3.0)
#
# @compression: migration compression statistics, only returned if compression
-# feature is on and status is 'active' or 'completed' (Since 3.1)
+# feature is on and status is 'active' or 'completed' (Since 3.1)
#
# @socket-address: Only used for tcp, to know what the real port is (Since 4.0)
#
@@ -355,54 +355,54 @@
# loads, by sending compressed difference of the pages
#
# @rdma-pin-all: Controls whether or not the entire VM memory footprint is
-# mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
-# Disabled by default. (since 2.0)
+# mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
+# Disabled by default. (since 2.0)
#
# @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
-# essentially saves 1MB of zeroes per block on the wire. Enabling requires
-# source and target VM to support this feature. To enable it is sufficient
-# to enable the capability on the source VM. The feature is disabled by
-# default. (since 1.6)
+# essentially saves 1MB of zeroes per block on the wire. Enabling requires
+# source and target VM to support this feature. To enable it is sufficient
+# to enable the capability on the source VM. The feature is disabled by
+# default. (since 1.6)
#
# @compress: Use multiple compression threads to accelerate live migration.
-# This feature can help to reduce the migration traffic, by sending
-# compressed pages. Please note that if compress and xbzrle are both
-# on, compress only takes effect in the ram bulk stage, after that,
-# it will be disabled and only xbzrle takes effect, this can help to
-# minimize migration traffic. The feature is disabled by default.
-# (since 2.4 )
+# This feature can help to reduce the migration traffic, by sending
+# compressed pages. Please note that if compress and xbzrle are both
+# on, compress only takes effect in the ram bulk stage, after that,
+# it will be disabled and only xbzrle takes effect, this can help to
+# minimize migration traffic. The feature is disabled by default.
+# (since 2.4 )
#
# @events: generate events for each migration state change
# (since 2.4 )
#
# @auto-converge: If enabled, QEMU will automatically throttle down the guest
-# to speed up convergence of RAM migration. (since 1.6)
+# to speed up convergence of RAM migration. (since 1.6)
#
# @postcopy-ram: Start executing on the migration target before all of RAM has
-# been migrated, pulling the remaining pages along as needed. The
-# capacity must have the same setting on both source and target
-# or migration will not even start. NOTE: If the migration fails during
-# postcopy the VM will fail. (since 2.6)
+# been migrated, pulling the remaining pages along as needed. The
+# capacity must have the same setting on both source and target
+# or migration will not even start. NOTE: If the migration fails during
+# postcopy the VM will fail. (since 2.6)
#
# @x-colo: If enabled, migration will never end, and the state of the VM on the
-# primary side will be migrated continuously to the VM on secondary
-# side, this process is called COarse-Grain LOck Stepping (COLO) for
-# Non-stop Service. (since 2.8)
+# primary side will be migrated continuously to the VM on secondary
+# side, this process is called COarse-Grain LOck Stepping (COLO) for
+# Non-stop Service. (since 2.8)
#
# @release-ram: if enabled, qemu will free the migrated ram pages on the source
-# during postcopy-ram migration. (since 2.9)
+# during postcopy-ram migration. (since 2.9)
#
# @block: If enabled, QEMU will also migrate the contents of all block
-# devices. Default is disabled. A possible alternative uses
-# mirror jobs to a builtin NBD server on the destination, which
-# offers more flexibility.
-# (Since 2.10)
+# devices. Default is disabled. A possible alternative uses
+# mirror jobs to a builtin NBD server on the destination, which
+# offers more flexibility.
+# (Since 2.10)
#
# @return-path: If enabled, migration will use the return path even
# for precopy. (since 2.10)
#
# @pause-before-switchover: Pause outgoing migration before serialising device
-# state and before disabling block IO (since 2.11)
+# state and before disabling block IO (since 2.11)
#
# @multifd: Use more than one fd for migration (since 4.0)
#
@@ -410,11 +410,11 @@
# (since 2.12)
#
# @postcopy-blocktime: Calculate downtime for postcopy live migration
-# (since 3.0)
+# (since 3.0)
#
# @late-block-activate: If enabled, the destination will not activate block
-# devices (and thus take locks) immediately at the end of migration.
-# (since 3.0)
+# devices (and thus take locks) immediately at the end of migration.
+# (since 3.0)
#
# @x-ignore-shared: If enabled, QEMU will not migrate shared memory (since 4.0)
#
@@ -494,24 +494,24 @@
# Migration parameters enumeration
#
# @announce-initial: Initial delay (in milliseconds) before sending the first
-# announce (Since 4.0)
+# announce (Since 4.0)
#
# @announce-max: Maximum delay (in milliseconds) between packets in the
-# announcement (Since 4.0)
+# announcement (Since 4.0)
#
# @announce-rounds: Number of self-announce packets sent after migration
-# (Since 4.0)
+# (Since 4.0)
#
# @announce-step: Increase in delay (in milliseconds) between subsequent
-# packets in the announcement (Since 4.0)
+# packets in the announcement (Since 4.0)
#
# @compress-level: Set the compression level to be used in live migration,
-# the compression level is an integer between 0 and 9, where 0 means
-# no compression, 1 means the best compression speed, and 9 means best
-# compression ratio which will consume more CPU.
+# the compression level is an integer between 0 and 9, where 0 means
+# no compression, 1 means the best compression speed, and 9 means best
+# compression ratio which will consume more CPU.
#
# @compress-threads: Set compression thread count to be used in live migration,
-# the compression thread count is an integer between 1 and 255.
+# the compression thread count is an integer between 1 and 255.
#
# @compress-wait-thread: Controls behavior when all compression threads are
# currently busy. If true (default), wait for a free
@@ -519,10 +519,10 @@
# send the page uncompressed. (Since 3.1)
#
# @decompress-threads: Set decompression thread count to be used in live
-# migration, the decompression thread count is an integer between 1
-# and 255. Usually, decompression is at least 4 times as fast as
-# compression, so set the decompress-threads to the number about 1/4
-# of compress-threads is adequate.
+# migration, the decompression thread count is an integer between 1
+# and 255. Usually, decompression is at least 4 times as fast as
+# compression, so set the decompress-threads to the number about 1/4
+# of compress-threads is adequate.
#
# @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
# when migration auto-converge is activated. The
@@ -560,14 +560,14 @@
# downtime in milliseconds (Since 2.8)
#
# @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
-# periodic mode. (Since 2.8)
+# periodic mode. (Since 2.8)
#
# @block-incremental: Affects how much storage is migrated when the
-# block migration capability is enabled. When false, the entire
-# storage backing chain is migrated into a flattened image at
-# the destination; when true, only the active qcow2 layer is
-# migrated and the destination must already have access to the
-# same backing chain as was used on the source. (since 2.10)
+# block migration capability is enabled. When false, the entire
+# storage backing chain is migrated into a flattened image at
+# the destination; when true, only the active qcow2 layer is
+# migrated and the destination must already have access to the
+# same backing chain as was used on the source. (since 2.10)
#
# @multifd-channels: Number of channels used to migrate data in
# parallel. This is the same number that the
@@ -580,8 +580,8 @@
# (Since 2.11)
#
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
-# Defaults to 0 (unlimited). In bytes per second.
-# (Since 3.0)
+# Defaults to 0 (unlimited). In bytes per second.
+# (Since 3.0)
#
# @max-cpu-throttle: maximum cpu throttle percentage.
# Defaults to 99. (Since 3.1)
@@ -604,16 +604,16 @@
# @MigrateSetParameters:
#
# @announce-initial: Initial delay (in milliseconds) before sending the first
-# announce (Since 4.0)
+# announce (Since 4.0)
#
# @announce-max: Maximum delay (in milliseconds) between packets in the
-# announcement (Since 4.0)
+# announcement (Since 4.0)
#
# @announce-rounds: Number of self-announce packets sent after migration
-# (Since 4.0)
+# (Since 4.0)
#
# @announce-step: Increase in delay (in milliseconds) between subsequent
-# packets in the announcement (Since 4.0)
+# packets in the announcement (Since 4.0)
#
# @compress-level: compression level
#
@@ -665,11 +665,11 @@
# @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
#
# @block-incremental: Affects how much storage is migrated when the
-# block migration capability is enabled. When false, the entire
-# storage backing chain is migrated into a flattened image at
-# the destination; when true, only the active qcow2 layer is
-# migrated and the destination must already have access to the
-# same backing chain as was used on the source. (since 2.10)
+# block migration capability is enabled. When false, the entire
+# storage backing chain is migrated into a flattened image at
+# the destination; when true, only the active qcow2 layer is
+# migrated and the destination must already have access to the
+# same backing chain as was used on the source. (since 2.10)
#
# @multifd-channels: Number of channels used to migrate data in
# parallel. This is the same number that the
@@ -682,8 +682,8 @@
# (Since 2.11)
#
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
-# Defaults to 0 (unlimited). In bytes per second.
-# (Since 3.0)
+# Defaults to 0 (unlimited). In bytes per second.
+# (Since 3.0)
#
# @max-cpu-throttle: maximum cpu throttle percentage.
# The default value is 99. (Since 3.1)
@@ -737,16 +737,16 @@
# The optional members aren't actually optional.
#
# @announce-initial: Initial delay (in milliseconds) before sending the
-# first announce (Since 4.0)
+# first announce (Since 4.0)
#
# @announce-max: Maximum delay (in milliseconds) between packets in the
-# announcement (Since 4.0)
+# announcement (Since 4.0)
#
# @announce-rounds: Number of self-announce packets sent after migration
-# (Since 4.0)
+# (Since 4.0)
#
# @announce-step: Increase in delay (in milliseconds) between subsequent
-# packets in the announcement (Since 4.0)
+# packets in the announcement (Since 4.0)
#
# @compress-level: compression level
#
@@ -799,11 +799,11 @@
# @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
#
# @block-incremental: Affects how much storage is migrated when the
-# block migration capability is enabled. When false, the entire
-# storage backing chain is migrated into a flattened image at
-# the destination; when true, only the active qcow2 layer is
-# migrated and the destination must already have access to the
-# same backing chain as was used on the source. (since 2.10)
+# block migration capability is enabled. When false, the entire
+# storage backing chain is migrated into a flattened image at
+# the destination; when true, only the active qcow2 layer is
+# migrated and the destination must already have access to the
+# same backing chain as was used on the source. (since 2.10)
#
# @multifd-channels: Number of channels used to migrate data in
# parallel. This is the same number that the
@@ -816,12 +816,12 @@
# (Since 2.11)
#
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
-# Defaults to 0 (unlimited). In bytes per second.
-# (Since 3.0)
+# Defaults to 0 (unlimited). In bytes per second.
+# (Since 3.0)
#
# @max-cpu-throttle: maximum cpu throttle percentage.
# Defaults to 99.
-# (Since 3.1)
+# (Since 3.1)
#
# Since: 2.4
##
@@ -1047,8 +1047,8 @@
# The reason for a COLO exit.
#
# @none: failover has never happened. This state does not occur
-# in the COLO_EXIT event, and is only visible in the result of
-# query-colo-status.
+# in the COLO_EXIT event, and is only visible in the result of
+# query-colo-status.
#
# @request: COLO exit is due to an external request.
#
@@ -1281,11 +1281,11 @@
# of the VM are not saved by this command.
#
# @filename: the file to save the state of the devices to as binary
-# data. See xen-save-devices-state.txt for a description of the binary
-# format.
+# data. See xen-save-devices-state.txt for a description of the binary
+# format.
#
# @live: Optional argument to ask QEMU to treat this command as part of a live
-# migration. Default to true. (since 2.11)
+# migration. Default to true. (since 2.11)
#
# Returns: Nothing on success
#
diff --git a/qapi/misc-target.json b/qapi/misc-target.json
index a00fd821ebc..dee3b459301 100644
--- a/qapi/misc-target.json
+++ b/qapi/misc-target.json
@@ -230,14 +230,14 @@
# QEMU/KVM software version, but also decided by the hardware that
# the program is running upon.
#
-# @version: version of GIC to be described. Currently, only 2 and 3
-# are supported.
+# @version: version of GIC to be described. Currently, only 2 and 3
+# are supported.
#
# @emulated: whether current QEMU/hardware supports emulated GIC
# device in user space.
#
-# @kernel: whether current QEMU/hardware supports hardware
-# accelerated GIC device in kernel.
+# @kernel: whether current QEMU/hardware supports hardware
+# accelerated GIC device in kernel.
#
# Since: 2.6
##
diff --git a/qapi/misc.json b/qapi/misc.json
index 33b94e35896..626a342b008 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -14,11 +14,11 @@
#
# Arguments:
#
-# @enable: An optional list of QMPCapability values to enable. The
-# client must not enable any capability that is not
-# mentioned in the QMP greeting message. If the field is not
-# provided, it means no QMP capabilities will be enabled.
-# (since 2.12)
+# @enable: An optional list of QMPCapability values to enable. The
+# client must not enable any capability that is not
+# mentioned in the QMP greeting message. If the field is not
+# provided, it means no QMP capabilities will be enabled.
+# (since 2.12)
#
# Example:
#
@@ -27,11 +27,11 @@
# <- { "return": {} }
#
# Notes: This command is valid exactly when first connecting: it must be
-# issued before any other command will be accepted, and will fail once the
-# monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)
+# issued before any other command will be accepted, and will fail once the
+# monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)
#
-# The QMP client needs to explicitly enable QMP capabilities, otherwise
-# all the QMP capabilities will be turned off by default.
+# The QMP client needs to explicitly enable QMP capabilities, otherwise
+# all the QMP capabilities will be turned off by default.
#
# Since: 0.13
#
@@ -46,8 +46,8 @@
# Enumeration of capabilities to be advertised during initial client
# connection, used for agreeing on particular QMP extension behaviors.
#
-# @oob: QMP ability to support out-of-band requests.
-# (Please refer to qmp-spec.txt for more information on OOB)
+# @oob: QMP ability to support out-of-band requests.
+# (Please refer to qmp-spec.txt for more information on OOB)
#
# Since: 2.12
#
@@ -60,11 +60,11 @@
#
# A three-part version number.
#
-# @major: The major version number.
+# @major: The major version number.
#
-# @minor: The minor version number.
+# @minor: The minor version number.
#
-# @micro: The micro version number.
+# @micro: The micro version number.
#
# Since: 2.4
##
@@ -77,16 +77,16 @@
#
# A description of QEMU's version.
#
-# @qemu: The version of QEMU. By current convention, a micro
-# version of 50 signifies a development branch. A micro version
-# greater than or equal to 90 signifies a release candidate for
-# the next minor version. A micro version of less than 50
-# signifies a stable release.
+# @qemu: The version of QEMU. By current convention, a micro
+# version of 50 signifies a development branch. A micro version
+# greater than or equal to 90 signifies a release candidate for
+# the next minor version. A micro version of less than 50
+# signifies a stable release.
#
-# @package: QEMU will always set this field to an empty string. Downstream
-# versions of QEMU should set this to a non-empty string. The
-# exact format depends on the downstream however it highly
-# recommended that a unique name is used.
+# @package: QEMU will always set this field to an empty string. Downstream
+# versions of QEMU should set this to a non-empty string. The
+# exact format depends on the downstream however it highly
+# recommended that a unique name is used.
#
# Since: 0.14.0
##
@@ -98,7 +98,7 @@
#
# Returns the current version of QEMU.
#
-# Returns: A @VersionInfo object describing the current version of QEMU.
+# Returns: A @VersionInfo object describing the current version of QEMU.
#
# Since: 0.14.0
#
@@ -321,7 +321,7 @@
# Since: 1.2.0
#
# Note: This command is deprecated, because its output doesn't reflect
-# compile-time configuration. Use query-qmp-schema instead.
+# compile-time configuration. Use query-qmp-schema instead.
#
# Example:
#
@@ -375,8 +375,8 @@
# Returns a list of information about each iothread.
#
# Note: this list excludes the QEMU main loop thread, which is not declared
-# using the -object iothread command-line option. It is always the main thread
-# of the process.
+# using the -object iothread command-line option. It is always the main thread
+# of the process.
#
# Returns: a list of @IOThreadInfo for each iothread
#
@@ -624,9 +624,9 @@
# Return information about the PCI bus topology of the guest.
#
# Returns: a list of @PciInfo for each PCI bus. Each bus is
-# represented by a json-object, which has a key with a json-array of
-# all PCI devices attached to it. Each device is represented by a
-# json-object.
+# represented by a json-object, which has a key with a json-array of
+# all PCI devices attached to it. Each device is represented by a
+# json-object.
#
# Since: 0.14.0
#
@@ -788,10 +788,10 @@
#
# Since: 0.14.0
#
-# Notes: This function will succeed even if the guest is already in the stopped
-# state. In "inmigrate" state, it will ensure that the guest
-# remains paused once migration finishes, as if the -S option was
-# passed on the command line.
+# Notes: This function will succeed even if the guest is already in the stopped
+# state. In "inmigrate" state, it will ensure that the guest
+# remains paused once migration finishes, as if the -S option was
+# passed on the command line.
#
# Example:
#
@@ -847,7 +847,7 @@
# @filename: the file to save the memory to as binary data
#
# @cpu-index: the index of the virtual CPU to use for translating the
-# virtual address (defaults to CPU 0)
+# virtual address (defaults to CPU 0)
#
# Returns: Nothing on success
#
@@ -905,11 +905,11 @@
#
# Returns: If successful, nothing
#
-# Notes: This command will succeed if the guest is currently running. It
-# will also succeed if the guest is in the "inmigrate" state; in
-# this case, the effect of the command is to make sure the guest
-# starts once migration finishes, removing the effect of the -S
-# command line option if it was passed.
+# Notes: This command will succeed if the guest is currently running. It
+# will also succeed if the guest is in the "inmigrate" state; in
+# this case, the effect of the command is to make sure the guest
+# starts once migration finishes, removing the effect of the -S
+# command line option if it was passed.
#
# Example:
#
@@ -955,7 +955,7 @@
# Returns: nothing.
#
# Note: prior to 4.0, this command does nothing in case the guest
-# isn't suspended.
+# isn't suspended.
#
# Example:
#
@@ -1069,18 +1069,18 @@
# change password command. Otherwise, this specifies a new server URI
# address to listen to for VNC connections.
#
-# @arg: If @device is a block device, then this is an optional format to open
-# the device with.
-# If @device is 'vnc' and @target is 'password', this is the new VNC
-# password to set. See change-vnc-password for additional notes.
+# @arg: If @device is a block device, then this is an optional format to open
+# the device with.
+# If @device is 'vnc' and @target is 'password', this is the new VNC
+# password to set. See change-vnc-password for additional notes.
#
# Returns: Nothing on success.
# If @device is not a valid block device, DeviceNotFound
#
-# Notes: This interface is deprecated, and it is strongly recommended that you
-# avoid using it. For changing block devices, use
-# blockdev-change-medium; for changing VNC parameters, use
-# change-vnc-password.
+# Notes: This interface is deprecated, and it is strongly recommended that you
+# avoid using it. For changing block devices, use
+# blockdev-change-medium; for changing VNC parameters, use
+# change-vnc-password.
#
# Since: 0.14.0
#
@@ -1719,8 +1719,8 @@
# of the VM are not loaded by this command.
#
# @filename: the file to load the state of the devices from as binary
-# data. See xen-save-devices-state.txt for a description of the binary
-# format.
+# data. See xen-save-devices-state.txt for a description of the binary
+# format.
#
# Since: 2.7
#
diff --git a/qapi/net.json b/qapi/net.json
index 335295be506..109eff71cd4 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -47,9 +47,9 @@
# Additional arguments depend on the type.
#
# TODO: This command effectively bypasses QAPI completely due to its
-# "additional arguments" business. It shouldn't have been added to
-# the schema in this form. It should be qapified properly, or
-# replaced by a properly qapified command.
+# "additional arguments" business. It shouldn't have been added to
+# the schema in this form. It should be qapified properly, or
+# replaced by a properly qapified command.
#
# Since: 0.14.0
#
@@ -213,7 +213,7 @@
# @fd: file descriptor of an already opened tap
#
# @fds: multiple file descriptors of already opened multiqueue capable
-# tap
+# tap
#
# @script: script to initialize the interface
#
@@ -232,14 +232,14 @@
# @vhostfd: file descriptor of an already opened vhost net device
#
# @vhostfds: file descriptors of multiple already opened vhost net
-# devices
+# devices
#
# @vhostforce: vhost on for non-MSIX virtio guests
#
# @queues: number of queues to be created for multiqueue capable tap
#
# @poll-us: maximum number of microseconds that could
-# be spent on busy polling for tap (since 2.7)
+# be spent on busy polling for tap (since 2.7)
#
# Since: 1.2
##
@@ -691,7 +691,7 @@
# Parameters for self-announce timers
#
# @initial: Initial delay (in ms) before sending the first GARP/RARP
-# announcement
+# announcement
#
# @max: Maximum delay (in ms) between GARP/RARP announcement packets
#
@@ -700,11 +700,11 @@
# @step: Delay increase (in ms) after each self-announcement attempt
#
# @interfaces: An optional list of interface names, which restricts the
-# announcement to the listed interfaces. (Since 4.1)
+# announcement to the listed interfaces. (Since 4.1)
#
# @id: A name to be used to identify an instance of announce-timers
-# and to allow it to modified later. Not for use as
-# part of the migration parameters. (Since 4.1)
+# and to allow it to modified later. Not for use as
+# part of the migration parameters. (Since 4.1)
#
# Since: 4.0
##
diff --git a/qapi/qdev.json b/qapi/qdev.json
index c6d05032f4a..f4ed9735c43 100644
--- a/qapi/qdev.json
+++ b/qapi/qdev.json
@@ -19,8 +19,8 @@
# Returns: a list of ObjectPropertyInfo describing a devices properties
#
# Note: objects can create properties at runtime, for example to describe
-# links between different devices and/or objects. These properties
-# are not included in the output of this command.
+# links between different devices and/or objects. These properties
+# are not included in the output of this command.
#
# Since: 1.2
##
@@ -58,9 +58,9 @@
# <- { "return": {} }
#
# TODO: This command effectively bypasses QAPI completely due to its
-# "additional arguments" business. It shouldn't have been added to
-# the schema in this form. It should be qapified properly, or
-# replaced by a properly qapified command.
+# "additional arguments" business. It shouldn't have been added to
+# the schema in this form. It should be qapified properly, or
+# replaced by a properly qapified command.
#
# Since: 0.13
##
diff --git a/qapi/qom.json b/qapi/qom.json
index 1e3c2ad5556..ecc60c4401c 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -189,8 +189,8 @@
# @typename: the type name of an object
#
# Note: objects can create properties at runtime, for example to describe
-# links between different devices and/or objects. These properties
-# are not included in the output of this command.
+# links between different devices and/or objects. These properties
+# are not included in the output of this command.
#
# Returns: a list of ObjectPropertyInfo describing object properties
#
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 3587661161d..52597db491a 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -140,7 +140,7 @@
# @ip-dst: IP header destination address
#
# Note: optional members may or may not appear in the flow key
-# depending if they're relevant to the flow key.
+# depending if they're relevant to the flow key.
#
# Since: 2.4
##
@@ -170,7 +170,7 @@
# @ip-tos: IP header TOS field
#
# Note: optional members may or may not appear in the flow mask
-# depending if they're relevant to the flow mask.
+# depending if they're relevant to the flow mask.
#
# Since: 2.4
##
@@ -197,7 +197,7 @@
# @out-pport: physical output port
#
# Note: optional members may or may not appear in the flow action
-# depending if they're relevant to the flow action.
+# depending if they're relevant to the flow action.
#
# Since: 2.4
##
@@ -235,7 +235,7 @@
# @name: switch name
#
# @tbl-id: flow table ID. If tbl-id is not specified, returns
-# flow information for all tables.
+# flow information for all tables.
#
# Returns: rocker OF-DPA flow information
#
@@ -291,7 +291,7 @@
# @ttl-check: perform TTL check
#
# Note: optional members may or may not appear in the group depending
-# if they're relevant to the group type.
+# if they're relevant to the group type.
#
# Since: 2.4
##
@@ -311,7 +311,7 @@
# @name: switch name
#
# @type: group type. If type is not specified, returns
-# group information for all group types.
+# group information for all group types.
#
# Returns: rocker OF-DPA group information
#
diff --git a/qapi/run-state.json b/qapi/run-state.json
index b83a436a3e6..2e229077400 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -15,16 +15,16 @@
# @finish-migrate: guest is paused to finish the migration process
#
# @inmigrate: guest is paused waiting for an incoming migration. Note
-# that this state does not tell whether the machine will start at the
-# end of the migration. This depends on the command-line -S option and
-# any invocation of 'stop' or 'cont' that has happened since QEMU was
-# started.
+# that this state does not tell whether the machine will start at the
+# end of the migration. This depends on the command-line -S option and
+# any invocation of 'stop' or 'cont' that has happened since QEMU was
+# started.
#
# @internal-error: An internal error that prevents further guest execution
-# has occurred
+# has occurred
#
# @io-error: the last IOP has failed and the device is configured to pause
-# on I/O errors
+# on I/O errors
#
# @paused: guest has been paused via the 'stop' command
#
@@ -85,8 +85,8 @@
# @guest-panic: Guest panicked, and command line turns that into a shutdown
#
# @subsystem-reset: Partial guest reset that does not trigger QMP events and
-# ignores --no-reboot. This is useful for sanitizing
-# hypercalls on s390 that are used during kexec/kdump/boot
+# ignores --no-reboot. This is useful for sanitizing
+# hypercalls on s390 that are used during kexec/kdump/boot
#
##
{ 'enum': 'ShutdownCause',
@@ -140,13 +140,13 @@
# about to exit.
#
# @guest: If true, the shutdown was triggered by a guest request (such as
-# a guest-initiated ACPI shutdown request or other hardware-specific action)
-# rather than a host request (such as sending qemu a SIGINT). (since 2.10)
+# a guest-initiated ACPI shutdown request or other hardware-specific action)
+# rather than a host request (such as sending qemu a SIGINT). (since 2.10)
#
# @reason: The @ShutdownCause which resulted in the SHUTDOWN. (since 4.0)
#
# Note: If the command-line option "-no-shutdown" has been specified, qemu will
-# not exit, and a STOP event will eventually follow the SHUTDOWN event
+# not exit, and a STOP event will eventually follow the SHUTDOWN event
#
# Since: 0.12.0
#
@@ -180,9 +180,9 @@
# Emitted when the virtual machine is reset
#
# @guest: If true, the reset was triggered by a guest request (such as
-# a guest-initiated ACPI reboot request or other hardware-specific action)
-# rather than a host request (such as the QMP command system_reset).
-# (since 2.10)
+# a guest-initiated ACPI reboot request or other hardware-specific action)
+# rather than a host request (such as the QMP command system_reset).
+# (since 2.10)
#
# @reason: The @ShutdownCause of the RESET. (since 4.0)
#
@@ -283,7 +283,7 @@
# @action: action that has been taken
#
# Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
-# followed respectively by the RESET, SHUTDOWN, or STOP events
+# followed respectively by the RESET, SHUTDOWN, or STOP events
#
# Note: This event is rate-limited.
#
@@ -441,12 +441,12 @@
# @disabled-wait: the CPU has entered a disabled wait state
#
# @extint-loop: clock comparator or cpu timer interrupt with new PSW enabled
-# for external interrupts
+# for external interrupts
#
# @pgmint-loop: program interrupt with BAD new PSW
#
# @opint-loop: operation exception interrupt with invalid code at the program
-# interrupt new PSW
+# interrupt new PSW
#
# Since: 2.12
##
diff --git a/qapi/sockets.json b/qapi/sockets.json
index 32375f3a361..ea933ed4b2b 100644
--- a/qapi/sockets.json
+++ b/qapi/sockets.json
@@ -89,7 +89,7 @@
# @port: port
#
# Note: string types are used to allow for possible future hostname or
-# service resolution support.
+# service resolution support.
#
# Since: 2.8
##
@@ -104,9 +104,9 @@
# Captures the address of a socket, which could also be a named file descriptor
#
# Note: This type is deprecated in favor of SocketAddress. The
-# difference between SocketAddressLegacy and SocketAddress is that the
-# latter is a flat union rather than a simple union. Flat is nicer
-# because it avoids nesting on the wire, i.e. that form has fewer {}.
+# difference between SocketAddressLegacy and SocketAddress is that the
+# latter is a flat union rather than a simple union. Flat is nicer
+# because it avoids nesting on the wire, i.e. that form has fewer {}.
#
# Since: 1.3
diff --git a/qapi/trace.json b/qapi/trace.json
index 799b254a186..4955e5a7503 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -52,14 +52,14 @@
#
# Returns: a list of @TraceEventInfo for the matching events
#
-# An event is returned if:
-# - its name matches the @name pattern, and
-# - if @vcpu is given, the event has the "vcpu" property.
+# An event is returned if:
+# - its name matches the @name pattern, and
+# - if @vcpu is given, the event has the "vcpu" property.
#
-# Therefore, if @vcpu is given, the operation will only match per-vCPU events,
-# returning their state on the specified vCPU. Special case: if @name is an
-# exact match, @vcpu is given and the event does not have the "vcpu" property,
-# an error is returned.
+# Therefore, if @vcpu is given, the operation will only match per-vCPU events,
+# returning their state on the specified vCPU. Special case: if @name is an
+# exact match, @vcpu is given and the event does not have the "vcpu" property,
+# an error is returned.
#
# Since: 2.2
#
diff --git a/qapi/transaction.json b/qapi/transaction.json
index 0590dbcd1ae..04301f1be79 100644
--- a/qapi/transaction.json
+++ b/qapi/transaction.json
@@ -132,8 +132,8 @@
# Errors depend on the operations of the transaction
#
# Note: The transaction aborts on the first failure. Therefore, there will be
-# information on only one failed operation returned in an error condition, and
-# subsequent actions will not have been attempted.
+# information on only one failed operation returned in an error condition, and
+# subsequent actions will not have been attempted.
#
# Since: 1.1
#
diff --git a/qapi/ui.json b/qapi/ui.json
index e04525d8b44..aced267a1e4 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -18,10 +18,10 @@
# @password: the new password
#
# @connected: how to handle existing clients when changing the
-# password. If nothing is specified, defaults to `keep'
-# `fail' to fail the command if clients are connected
-# `disconnect' to disconnect existing clients
-# `keep' to maintain existing clients
+# password. If nothing is specified, defaults to `keep'
+# `fail' to fail the command if clients are connected
+# `disconnect' to disconnect existing clients
+# `keep' to maintain existing clients
#
# Returns: Nothing on success
# If Spice is not enabled, DeviceNotFound
@@ -591,12 +591,12 @@
#
# Change the VNC server password.
#
-# @password: the new password to use with VNC authentication
+# @password: the new password to use with VNC authentication
#
# Since: 1.1
#
-# Notes: An empty password in this command will set the password to the empty
-# string. Existing clients are unaffected by executing this command.
+# Notes: An empty password in this command will set the password to the empty
+# string. Existing clients are unaffected by executing this command.
##
{ 'command': 'change-vnc-password',
'data': { 'password': 'str' },
@@ -612,7 +612,7 @@
# @client: client information
#
# Note: This event is emitted before any authentication takes place, thus
-# the authentication ID is not provided
+# the authentication ID is not provided
#
# Since: 0.13.0
#
@@ -915,9 +915,9 @@
#
# Pointer motion input event.
#
-# @axis: Which axis is referenced by @value.
-# @value: Pointer position. For absolute coordinates the
-# valid range is 0 -> 0x7ffff
+# @axis: Which axis is referenced by @value.
+# @value: Pointer position. For absolute coordinates the
+# valid range is 0 -> 0x7ffff
#
# Since: 2.0
##
@@ -931,10 +931,10 @@
# Input event union.
#
# @type: the input type, one of:
-# - 'key': Input event of Keyboard
-# - 'btn': Input event of pointer buttons
-# - 'rel': Input event of relative pointer motion
-# - 'abs': Input event of absolute pointer motion
+# - 'key': Input event of Keyboard
+# - 'btn': Input event of pointer buttons
+# - 'rel': Input event of relative pointer motion
+# - 'abs': Input event of absolute pointer motion
#
# Since: 2.0
##
@@ -970,9 +970,9 @@
# Since: 2.6
#
# Note: The consoles are visible in the qom tree, under
-# /backend/console[$index]. They have a device link and head property,
-# so it is possible to map which console belongs to which device and
-# display.
+# /backend/console[$index]. They have a device link and head property,
+# so it is possible to map which console belongs to which device and
+# display.
#
# Example:
#
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 09/29] qapi: Fix indent level on doc comments in json files
2020-02-06 17:30 ` [PATCH 09/29] qapi: Fix indent level on doc comments in json files Peter Maydell
@ 2020-02-07 9:31 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 9:31 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> The texinfo doc generation doesn't care much about
> indentation levels, but we would like to add a rST
> backend, and rST does care about indentation.
>
> Make the doc comments more strongly consistent about indentation
> for multiline constructs like:
>
> @arg: description line 1
> description line 2
>
> Returns: line one
> line 2
>
> so that there is always exactly one space after the
> colon, and subsequent lines align with the first.
>
> This commit is a purely whitespace change, and it does
> not alter the generated .texi files (because the texi
> generation code strips away all the extra whitespace).
> This does mean that we end up with some over-length lines.
Overlong lines need to be corrected. Not necessarily in this patch.
> Note that when the documentation for an argument fits
> on a single line like this:
>
> @arg: one line only
>
> then stray extra spaces after the ':' don't affect the
> rST output, so I have not attempted to methodically
> fix them, though the preference is a single space here too.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Same commit message body as PATCH 05, except for the line wrapping.
I like PATCH 05's better.
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 10/29] qapi: Remove hardcoded tabs
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (8 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 09/29] qapi: Fix indent level on doc comments in json files Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 9:32 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place Peter Maydell
` (23 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
There are some stray hardcoded tabs in some of our json files;
remove them.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Most of the hardcoded tabs got removed in passing in
fixing the indent in lines that they were in, but
these are not part of doc comments.
---
qapi/block-core.json | 4 ++--
qapi/migration.json | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 006a0bf7a7c..6cc8a4f73e0 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2938,8 +2938,8 @@
'*pr-manager': 'str',
'*locking': 'OnOffAuto',
'*aio': 'BlockdevAioOptions',
- '*drop-cache': {'type': 'bool',
- 'if': 'defined(CONFIG_LINUX)'},
+ '*drop-cache': {'type': 'bool',
+ 'if': 'defined(CONFIG_LINUX)'},
'*x-check-cache-dropped': 'bool' },
'features': [ { 'name': 'dynamic-auto-read-only',
'if': 'defined(CONFIG_POSIX)' } ] }
diff --git a/qapi/migration.json b/qapi/migration.json
index aa160e9e42d..11033b7a8e6 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -98,7 +98,7 @@
##
{ 'struct': 'CompressionStats',
'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number',
- 'compressed-size': 'int', 'compression-rate': 'number' } }
+ 'compressed-size': 'int', 'compression-rate': 'number' } }
##
# @MigrationStatus:
@@ -713,7 +713,7 @@
'*multifd-channels': 'int',
'*xbzrle-cache-size': 'size',
'*max-postcopy-bandwidth': 'size',
- '*max-cpu-throttle': 'int' } }
+ '*max-cpu-throttle': 'int' } }
##
# @migrate-set-parameters:
@@ -845,7 +845,7 @@
'*block-incremental': 'bool' ,
'*multifd-channels': 'uint8',
'*xbzrle-cache-size': 'size',
- '*max-postcopy-bandwidth': 'size',
+ '*max-postcopy-bandwidth': 'size',
'*max-cpu-throttle':'uint8'} }
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 10/29] qapi: Remove hardcoded tabs
2020-02-06 17:30 ` [PATCH 10/29] qapi: Remove hardcoded tabs Peter Maydell
@ 2020-02-07 9:32 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 9:32 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> There are some stray hardcoded tabs in some of our json files;
> remove them.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Most of the hardcoded tabs got removed in passing in
> fixing the indent in lines that they were in, but
> these are not part of doc comments.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (9 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 10/29] qapi: Remove hardcoded tabs Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 9:45 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section Peter Maydell
` (22 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
In the doc comment for input-send-event, there is a multi-line
chunk of text ("The @device...take precedence") which is intended
to be the main body text describing the event. However it has
been placed after the arguments and Returns: section, which
means that the parser actually thinks that this text is
part of the "Returns" section text.
Move the body text up to the top so that the parser correctly
classifies it as body.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/ui.json | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index aced267a1e4..94a07318f55 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -949,13 +949,6 @@
#
# Send input event(s) to guest.
#
-# @device: display device to send event(s) to.
-# @head: head to send event(s) to, in case the
-# display device supports multiple scanouts.
-# @events: List of InputEvent union.
-#
-# Returns: Nothing on success.
-#
# The @device and @head parameters can be used to send the input event
# to specific input devices in case (a) multiple input devices of the
# same kind are added to the virtual machine and (b) you have
@@ -967,6 +960,13 @@
# are admissible, but devices with input routing config take
# precedence.
#
+# @device: display device to send event(s) to.
+# @head: head to send event(s) to, in case the
+# display device supports multiple scanouts.
+# @events: List of InputEvent union.
+#
+# Returns: Nothing on success.
+#
# Since: 2.6
#
# Note: The consoles are visible in the qom tree, under
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place
2020-02-06 17:30 ` [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place Peter Maydell
@ 2020-02-07 9:45 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 9:45 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> In the doc comment for input-send-event, there is a multi-line
> chunk of text ("The @device...take precedence") which is intended
> to be the main body text describing the event. However it has
> been placed after the arguments and Returns: section, which
> means that the parser actually thinks that this text is
> part of the "Returns" section text.
>
> Move the body text up to the top so that the parser correctly
> classifies it as body.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/ui.json | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/qapi/ui.json b/qapi/ui.json
> index aced267a1e4..94a07318f55 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -949,13 +949,6 @@
> #
> # Send input event(s) to guest.
> #
> -# @device: display device to send event(s) to.
> -# @head: head to send event(s) to, in case the
> -# display device supports multiple scanouts.
> -# @events: List of InputEvent union.
> -#
> -# Returns: Nothing on success.
> -#
> # The @device and @head parameters can be used to send the input event
> # to specific input devices in case (a) multiple input devices of the
> # same kind are added to the virtual machine and (b) you have
> @@ -967,6 +960,13 @@
> # are admissible, but devices with input routing config take
> # precedence.
> #
> +# @device: display device to send event(s) to.
> +# @head: head to send event(s) to, in case the
> +# display device supports multiple scanouts.
> +# @events: List of InputEvent union.
> +#
> +# Returns: Nothing on success.
> +#
> # Since: 2.6
> #
> # Note: The consoles are visible in the qom tree, under
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (10 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 10:06 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting Peter Maydell
` (21 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
A handful of QAPI doc comments include lines like
"ppcemb: dropped in 3.1". The doc comment parser will just
put these into whatever the preceding section was; sometimes
that's "Notes", and sometimes it's some random other section,
as with "NetClientDriver" where the "'dump': dropped in 2.12"
line ends up in the "Since:" section.
Put all of these explicitly into Notes: sections (either
preexisting or new), with the right indentation, and
standardising on quoting of the symbol with ''.
In the case of QKeyCode, the generated docs were actively
misformatted:
ac_bookmarks
since 2.10 altgr, altgr_r: dropped in 2.10
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/machine.json | 2 +-
qapi/net.json | 6 +++---
qapi/ui.json | 3 ++-
3 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 704b2b0fe31..51ffa96be98 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -20,7 +20,7 @@
# prefix to produce the corresponding QEMU executable name. This
# is true even for "qemu-system-x86_64".
#
-# ppcemb: dropped in 3.1
+# 'ppcemb': dropped in 3.1
#
# Since: 3.0
##
diff --git a/qapi/net.json b/qapi/net.json
index 109eff71cd4..8fbcbc611b9 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -447,7 +447,7 @@
#
# Since: 2.7
#
-# 'dump': dropped in 2.12
+# Notes: 'dump': dropped in 2.12
##
{ 'enum': 'NetClientDriver',
'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
@@ -464,7 +464,7 @@
#
# Since: 1.2
#
-# 'l2tpv3' - since 2.1
+# Notes: 'l2tpv3' - since 2.1
##
{ 'union': 'Netdev',
'base': { 'id': 'str', 'type': 'NetClientDriver' },
@@ -494,7 +494,7 @@
#
# Since: 1.2
#
-# 'vlan': dropped in 3.0
+# Notes: 'vlan': dropped in 3.0
##
{ 'struct': 'NetLegacy',
'data': {
diff --git a/qapi/ui.json b/qapi/ui.json
index 94a07318f55..6da52b81143 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -776,7 +776,6 @@
# @ac_forward: since 2.10
# @ac_refresh: since 2.10
# @ac_bookmarks: since 2.10
-# altgr, altgr_r: dropped in 2.10
#
# @muhenkan: since 2.12
# @katakanahiragana: since 2.12
@@ -790,6 +789,8 @@
#
# Since: 1.3.0
#
+# Notes: - 'altgr': dropped in 2.10
+# - 'altgr_r': dropped in 2.10
##
{ 'enum': 'QKeyCode',
'data': [ 'unmapped',
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section
2020-02-06 17:30 ` [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section Peter Maydell
@ 2020-02-07 10:06 ` Markus Armbruster
2020-02-07 14:23 ` Eric Blake
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 10:06 UTC (permalink / raw)
To: Peter Maydell
Cc: Thomas Huth, Daniel P. Berrangé,
qemu-devel, Michael Roth, Gerd Hoffmann, Stefan Hajnoczi,
John Snow
Peter Maydell <peter.maydell@linaro.org> writes:
> A handful of QAPI doc comments include lines like
> "ppcemb: dropped in 3.1". The doc comment parser will just
> put these into whatever the preceding section was; sometimes
> that's "Notes", and sometimes it's some random other section,
> as with "NetClientDriver" where the "'dump': dropped in 2.12"
> line ends up in the "Since:" section.
>
> Put all of these explicitly into Notes: sections (either
> preexisting or new), with the right indentation, and
> standardising on quoting of the symbol with ''.
>
> In the case of QKeyCode, the generated docs were actively
> misformatted:
> ac_bookmarks
> since 2.10 altgr, altgr_r: dropped in 2.10
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/machine.json | 2 +-
> qapi/net.json | 6 +++---
> qapi/ui.json | 3 ++-
> 3 files changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 704b2b0fe31..51ffa96be98 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -20,7 +20,7 @@
> # prefix to produce the corresponding QEMU executable name. This
> # is true even for "qemu-system-x86_64".
> #
> -# ppcemb: dropped in 3.1
> +# 'ppcemb': dropped in 3.1
> #
> # Since: 3.0
> ##
> diff --git a/qapi/net.json b/qapi/net.json
> index 109eff71cd4..8fbcbc611b9 100644
> --- a/qapi/net.json
> +++ b/qapi/net.json
> @@ -447,7 +447,7 @@
> #
> # Since: 2.7
> #
> -# 'dump': dropped in 2.12
> +# Notes: 'dump': dropped in 2.12
> ##
> { 'enum': 'NetClientDriver',
> 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
> @@ -464,7 +464,7 @@
> #
> # Since: 1.2
> #
> -# 'l2tpv3' - since 2.1
> +# Notes: 'l2tpv3' - since 2.1
> ##
> { 'union': 'Netdev',
> 'base': { 'id': 'str', 'type': 'NetClientDriver' },
> @@ -494,7 +494,7 @@
> #
> # Since: 1.2
> #
> -# 'vlan': dropped in 3.0
> +# Notes: 'vlan': dropped in 3.0
> ##
> { 'struct': 'NetLegacy',
> 'data': {
> diff --git a/qapi/ui.json b/qapi/ui.json
> index 94a07318f55..6da52b81143 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -776,7 +776,6 @@
> # @ac_forward: since 2.10
> # @ac_refresh: since 2.10
> # @ac_bookmarks: since 2.10
> -# altgr, altgr_r: dropped in 2.10
> #
> # @muhenkan: since 2.12
> # @katakanahiragana: since 2.12
> @@ -790,6 +789,8 @@
> #
> # Since: 1.3.0
> #
> +# Notes: - 'altgr': dropped in 2.10
> +# - 'altgr_r': dropped in 2.10
> ##
> { 'enum': 'QKeyCode',
> 'data': [ 'unmapped',
I'm not sure the "dropped in" notes are worth their keep. One, they are
too incomplete to be of much use. Two, I think qemu-deprecated.texi is
a better home for this kind of information. Easier to consume for the
people who need to know. In particular, they can watch the sausage
being made by getting themselves added to MAINTAINERS section
"Incompatible changes".
If we decide we want to document "dropped in" in the schema, then we
need to make an effort to reconstruct the missing ones. Also, members
names should use @name markup, not 'name'.
Cc'ing people ratted out by git-log -S'dropped in'.
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section
2020-02-07 10:06 ` Markus Armbruster
@ 2020-02-07 14:23 ` Eric Blake
0 siblings, 0 replies; 77+ messages in thread
From: Eric Blake @ 2020-02-07 14:23 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell
Cc: Thomas Huth, Daniel P. Berrangé,
qemu-devel, Michael Roth, Gerd Hoffmann, Stefan Hajnoczi,
John Snow
On 2/7/20 4:06 AM, Markus Armbruster wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> A handful of QAPI doc comments include lines like
>> "ppcemb: dropped in 3.1". The doc comment parser will just
>> put these into whatever the preceding section was; sometimes
>> that's "Notes", and sometimes it's some random other section,
>> as with "NetClientDriver" where the "'dump': dropped in 2.12"
>> line ends up in the "Since:" section.
>>
>> Put all of these explicitly into Notes: sections (either
>> preexisting or new), with the right indentation, and
>> standardising on quoting of the symbol with ''.
>>
>
> I'm not sure the "dropped in" notes are worth their keep. One, they are
> too incomplete to be of much use. Two, I think qemu-deprecated.texi is
> a better home for this kind of information. Easier to consume for the
> people who need to know. In particular, they can watch the sausage
> being made by getting themselves added to MAINTAINERS section
> "Incompatible changes".
We first started adding dropped-in notes at least as early as commit
912092b (part of v2.10.0), with the 'altgr'/'altgr_r' members of
QKeyCode. We did not have qemu-deprecated.texi until commit 44c67847
(v3.0.0), so the markings originally made sense.
But now that we have a better place for someone to look up "why is my
QAPI command not working? oh, qemu-deprecated documents that it was
removed, AND tells me details such as why it was useless or what to use
in its place", I don't see the need to burden QAPI docs with a mere
"this old form with no further documentation used to exist, but you
can't use it now, and furthermore this tidbit of information didn't
teach you anything useful about what _does_ work with this command" line.
>
> If we decide we want to document "dropped in" in the schema, then we
> need to make an effort to reconstruct the missing ones. Also, members
> names should use @name markup, not 'name'.
>
> Cc'ing people ratted out by git-log -S'dropped in'.
I'm all in favor of stopping the use of 'dropped in' in QAPI source
files, and sticking to qemu-deprecated.texi instead.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (11 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 10:13 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists Peter Maydell
` (20 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Avoid texinfo style quoting with `...', because rST treats it
as a syntax error. Use '...' instead, as we do in other
doc comments. This looks OK in texinfo, and rST formats it as
paired-quotation-marks.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/ui.json | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index 6da52b81143..92d409c32c8 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -12,16 +12,16 @@
#
# Sets the password of a remote display session.
#
-# @protocol: `vnc' to modify the VNC server password
-# `spice' to modify the Spice server password
+# @protocol: 'vnc' to modify the VNC server password
+# 'spice' to modify the Spice server password
#
# @password: the new password
#
# @connected: how to handle existing clients when changing the
-# password. If nothing is specified, defaults to `keep'
-# `fail' to fail the command if clients are connected
-# `disconnect' to disconnect existing clients
-# `keep' to maintain existing clients
+# password. If nothing is specified, defaults to 'keep'
+# 'fail' to fail the command if clients are connected
+# 'disconnect' to disconnect existing clients
+# 'keep' to maintain existing clients
#
# Returns: Nothing on success
# If Spice is not enabled, DeviceNotFound
@@ -43,16 +43,16 @@
#
# Expire the password of a remote display server.
#
-# @protocol: the name of the remote display protocol `vnc' or `spice'
+# @protocol: the name of the remote display protocol 'vnc' or 'spice'
#
# @time: when to expire the password.
-# `now' to expire the password immediately
-# `never' to cancel password expiration
-# `+INT' where INT is the number of seconds from now (integer)
-# `INT' where INT is the absolute time in seconds
+# 'now' to expire the password immediately
+# 'never' to cancel password expiration
+# '+INT' where INT is the number of seconds from now (integer)
+# 'INT' where INT is the absolute time in seconds
#
# Returns: Nothing on success
-# If @protocol is `spice' and Spice is not active, DeviceNotFound
+# If @protocol is 'spice' and Spice is not active, DeviceNotFound
#
# Since: 0.14.0
#
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting
2020-02-06 17:30 ` [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting Peter Maydell
@ 2020-02-07 10:13 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 10:13 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> Avoid texinfo style quoting with `...', because rST treats it
> as a syntax error. Use '...' instead, as we do in other
> doc comments. This looks OK in texinfo, and rST formats it as
> paired-quotation-marks.
It's kind of wrong in TexInfo; results in "Right single quotation mark"
(U+2019) on both ends. But we're doing it this kind of wrong all over
the place anyway, and the wrongness will go away when we switch to rST.
Acceptable.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (12 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 12:07 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 15/29] qapi/ui.json: " Peter Maydell
` (19 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders in the HTML and manpage like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 108 +++++++++++++++++++++----------------------
1 file changed, 54 insertions(+), 54 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 6cc8a4f73e0..9e878e39336 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1326,8 +1326,8 @@
#
# @size: new image size in bytes
#
-# Returns: nothing on success
-# If @device is not a valid block device, DeviceNotFound
+# Returns: - nothing on success
+# - If @device is not a valid block device, DeviceNotFound
#
# Since: 0.14.0
#
@@ -1510,8 +1510,8 @@
#
# For the arguments, see the documentation of BlockdevSnapshotSync.
#
-# Returns: nothing on success
-# If @device is not a valid block device, DeviceNotFound
+# Returns: - nothing on success
+# - If @device is not a valid block device, DeviceNotFound
#
# Since: 0.14.0
#
@@ -1586,9 +1586,8 @@
# when specifying the string or the image chain may
# not be able to be reopened again.
#
-# Returns: Nothing on success
-#
-# If "device" does not exist or cannot be determined, DeviceNotFound
+# Returns: - Nothing on success
+# - If "device" does not exist or cannot be determined, DeviceNotFound
#
# Since: 2.1
##
@@ -1674,9 +1673,9 @@
# list without user intervention.
# Defaults to true. (Since 3.1)
#
-# Returns: Nothing on success
-# If @device does not exist, DeviceNotFound
-# Any other error returns a GenericError.
+# Returns: - Nothing on success
+# - If @device does not exist, DeviceNotFound
+# - Any other error returns a GenericError.
#
# Since: 1.3
#
@@ -1704,8 +1703,8 @@
# The operation can be stopped before it has completed using the
# block-job-cancel command.
#
-# Returns: nothing on success
-# If @device is not a valid block device, GenericError
+# Returns: - nothing on success
+# - If @device is not a valid block device, GenericError
#
# Since: 1.6
#
@@ -1730,8 +1729,8 @@
# The operation can be stopped before it has completed using the
# block-job-cancel command.
#
-# Returns: nothing on success
-# If @device is not a valid block device, DeviceNotFound
+# Returns: - nothing on success
+# - If @device is not a valid block device, DeviceNotFound
#
# Since: 2.3
#
@@ -1925,8 +1924,8 @@
# format of the mirror image, default is to probe if mode='existing',
# else the format of the source.
#
-# Returns: nothing on success
-# If @device is not a valid block device, GenericError
+# Returns: - nothing on success
+# - If @device is not a valid block device, GenericError
#
# Since: 1.3
#
@@ -2097,9 +2096,9 @@
#
# Create a dirty bitmap with a name on the node, and start tracking the writes.
#
-# Returns: nothing on success
-# If @node is not a valid block device or node, DeviceNotFound
-# If @name is already taken, GenericError with an explanation
+# Returns: - nothing on success
+# - If @node is not a valid block device or node, DeviceNotFound
+# - If @name is already taken, GenericError with an explanation
#
# Since: 2.4
#
@@ -2120,10 +2119,10 @@
# with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its
# storage too.
#
-# Returns: nothing on success
-# If @node is not a valid block device or node, DeviceNotFound
-# If @name is not found, GenericError with an explanation
-# if @name is frozen by an operation, GenericError
+# Returns: - nothing on success
+# - If @node is not a valid block device or node, DeviceNotFound
+# - If @name is not found, GenericError with an explanation
+# - if @name is frozen by an operation, GenericError
#
# Since: 2.4
#
@@ -2144,9 +2143,9 @@
# backup from this point in time forward will only backup clusters
# modified after this clear operation.
#
-# Returns: nothing on success
-# If @node is not a valid block device, DeviceNotFound
-# If @name is not found, GenericError with an explanation
+# Returns: - nothing on success
+# - If @node is not a valid block device, DeviceNotFound
+# - If @name is not found, GenericError with an explanation
#
# Since: 2.4
#
@@ -2165,9 +2164,9 @@
#
# Enables a dirty bitmap so that it will begin tracking disk changes.
#
-# Returns: nothing on success
-# If @node is not a valid block device, DeviceNotFound
-# If @name is not found, GenericError with an explanation
+# Returns: - nothing on success
+# - If @node is not a valid block device, DeviceNotFound
+# - If @name is not found, GenericError with an explanation
#
# Since: 4.0
#
@@ -2186,9 +2185,9 @@
#
# Disables a dirty bitmap so that it will stop tracking disk changes.
#
-# Returns: nothing on success
-# If @node is not a valid block device, DeviceNotFound
-# If @name is not found, GenericError with an explanation
+# Returns: - nothing on success
+# - If @node is not a valid block device, DeviceNotFound
+# - If @name is not found, GenericError with an explanation
#
# Since: 4.0
#
@@ -2215,11 +2214,11 @@
# of the source bitmaps. This can be used to achieve backup checkpoints, or in
# simpler usages, to copy bitmaps.
#
-# Returns: nothing on success
-# If @node is not a valid block device, DeviceNotFound
-# If any bitmap in @bitmaps or @target is not found, GenericError
-# If any of the bitmaps have different sizes or granularities,
-# GenericError
+# Returns: - nothing on success
+# - If @node is not a valid block device, DeviceNotFound
+# - If any bitmap in @bitmaps or @target is not found, GenericError
+# - If any of the bitmaps have different sizes or granularities,
+# GenericError
#
# Since: 4.0
#
@@ -2251,10 +2250,10 @@
#
# Get bitmap SHA256.
#
-# Returns: BlockDirtyBitmapSha256 on success
-# If @node is not a valid block device, DeviceNotFound
-# If @name is not found or if hashing has failed, GenericError with an
-# explanation
+# Returns: - BlockDirtyBitmapSha256 on success
+# - If @node is not a valid block device, DeviceNotFound
+# - If @name is not found or if hashing has failed, GenericError with an
+# explanation
#
# Since: 2.10
##
@@ -2371,8 +2370,8 @@
# the device will be removed from its group and the rest of its
# members will not be affected. The 'group' parameter is ignored.
#
-# Returns: Nothing on success
-# If @device is not a valid block device, DeviceNotFound
+# Returns: - Nothing on success
+# - If @device is not a valid block device, DeviceNotFound
#
# Since: 1.1
#
@@ -2622,7 +2621,8 @@
# list without user intervention.
# Defaults to true. (Since 3.1)
#
-# Returns: Nothing on success. If @device does not exist, DeviceNotFound.
+# Returns: - Nothing on success.
+# - If @device does not exist, DeviceNotFound.
#
# Since: 1.1
#
@@ -2656,8 +2656,8 @@
# @speed: the maximum speed, in bytes per second, or 0 for unlimited.
# Defaults to 0.
#
-# Returns: Nothing on success
-# If no background operation is active on this device, DeviceNotActive
+# Returns: - Nothing on success
+# - If no background operation is active on this device, DeviceNotActive
#
# Since: 1.1
##
@@ -2696,8 +2696,8 @@
# abandon the job immediately (even if it is paused) instead of waiting
# for the destination to complete its final synchronization (since 1.3)
#
-# Returns: Nothing on success
-# If no background operation is active on this device, DeviceNotActive
+# Returns: - Nothing on success
+# - If no background operation is active on this device, DeviceNotActive
#
# Since: 1.1
##
@@ -2720,8 +2720,8 @@
# the name of the parameter), but since QEMU 2.7 it can have
# other values.
#
-# Returns: Nothing on success
-# If no background operation is active on this device, DeviceNotActive
+# Returns: - Nothing on success
+# - If no background operation is active on this device, DeviceNotActive
#
# Since: 1.3
##
@@ -2742,8 +2742,8 @@
# the name of the parameter), but since QEMU 2.7 it can have
# other values.
#
-# Returns: Nothing on success
-# If no background operation is active on this device, DeviceNotActive
+# Returns: - Nothing on success
+# - If no background operation is active on this device, DeviceNotActive
#
# Since: 1.3
##
@@ -2770,8 +2770,8 @@
# the name of the parameter), but since QEMU 2.7 it can have
# other values.
#
-# Returns: Nothing on success
-# If no background operation is active on this device, DeviceNotActive
+# Returns: - Nothing on success
+# - If no background operation is active on this device, DeviceNotActive
#
# Since: 1.3
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists
2020-02-06 17:30 ` [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists Peter Maydell
@ 2020-02-07 12:07 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 12:07 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> A JSON block comment like this:
> Returns: nothing on success
> If @node is not a valid block device, DeviceNotFound
> If @name is not found, GenericError with an explanation
>
> renders in the HTML and manpage like this:
>
> Returns: nothing on success If node is not a valid block device,
> DeviceNotFound If name is not found, GenericError with an explanation
>
> because whitespace is not significant.
Pretty much the same in plain text and PDF. Unsurprising, as all are
generated from the same, flawed TexInfo. Suggest "renders like this".
>
> Use an actual bulleted list, so that the formatting is correct.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 15/29] qapi/ui.json: Use explicit bulleted lists
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (13 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 16/29] qapi/{block, misc, tmp}.json: " Peter Maydell
` (18 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders in the HTML and manpage like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/ui.json | 63 +++++++++++++++++++++++++++-------------------------
1 file changed, 33 insertions(+), 30 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index 92d409c32c8..f527bbdc26e 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -12,8 +12,8 @@
#
# Sets the password of a remote display session.
#
-# @protocol: 'vnc' to modify the VNC server password
-# 'spice' to modify the Spice server password
+# @protocol: - 'vnc' to modify the VNC server password
+# - 'spice' to modify the Spice server password
#
# @password: the new password
#
@@ -23,8 +23,8 @@
# 'disconnect' to disconnect existing clients
# 'keep' to maintain existing clients
#
-# Returns: Nothing on success
-# If Spice is not enabled, DeviceNotFound
+# Returns: - Nothing on success
+# - If Spice is not enabled, DeviceNotFound
#
# Since: 0.14.0
#
@@ -46,13 +46,14 @@
# @protocol: the name of the remote display protocol 'vnc' or 'spice'
#
# @time: when to expire the password.
-# 'now' to expire the password immediately
-# 'never' to cancel password expiration
-# '+INT' where INT is the number of seconds from now (integer)
-# 'INT' where INT is the absolute time in seconds
#
-# Returns: Nothing on success
-# If @protocol is 'spice' and Spice is not active, DeviceNotFound
+# - 'now' to expire the password immediately
+# - 'never' to cancel password expiration
+# - '+INT' where INT is the number of seconds from now (integer)
+# - 'INT' where INT is the absolute time in seconds
+#
+# Returns: - Nothing on success
+# - If @protocol is 'spice' and Spice is not active, DeviceNotFound
#
# Since: 0.14.0
#
@@ -201,9 +202,10 @@
# @tls-port: The SPICE server's TLS port number.
#
# @auth: the current authentication type used by the server
-# 'none' if no authentication is being used
-# 'spice' uses SASL or direct TLS authentication, depending on command
-# line options
+#
+# - 'none' if no authentication is being used
+# - 'spice' uses SASL or direct TLS authentication, depending on command
+# line options
#
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
# be determined by the client or the server, or unknown if spice
@@ -433,27 +435,28 @@
# @host: The hostname the VNC server is bound to. This depends on
# the name resolution on the host and may be an IP address.
#
-# @family: 'ipv6' if the host is listening for IPv6 connections
-# 'ipv4' if the host is listening for IPv4 connections
-# 'unix' if the host is listening on a unix domain socket
-# 'unknown' otherwise
+# @family: - 'ipv6' if the host is listening for IPv6 connections
+# - 'ipv4' if the host is listening for IPv4 connections
+# - 'unix' if the host is listening on a unix domain socket
+# - 'unknown' otherwise
#
# @service: The service name of the server's port. This may depends
# on the host system's service database so symbolic names should not
# be relied on.
#
# @auth: the current authentication type used by the server
-# 'none' if no authentication is being used
-# 'vnc' if VNC authentication is being used
-# 'vencrypt+plain' if VEncrypt is used with plain text authentication
-# 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
-# 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
-# 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
-# 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
-# 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
-# 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
-# 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
-# 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
+#
+# - 'none' if no authentication is being used
+# - 'vnc' if VNC authentication is being used
+# - 'vencrypt+plain' if VEncrypt is used with plain text authentication
+# - 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
+# - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
+# - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
+# - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
+# - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
+# - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
+# - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
+# - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
#
# @clients: a list of @VncClientInfo of all currently connected clients
#
@@ -841,8 +844,8 @@
# @hold-time: time to delay key up events, milliseconds. Defaults
# to 100
#
-# Returns: Nothing on success
-# If key is unknown or redundant, InvalidParameter
+# Returns: - Nothing on success
+# - If key is unknown or redundant, InvalidParameter
#
# Since: 1.3.0
#
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 16/29] qapi/{block, misc, tmp}.json: Use explicit bulleted lists
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (14 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 15/29] qapi/ui.json: " Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 10:33 ` Philippe Mathieu-Daudé
2020-02-06 17:30 ` [PATCH 17/29] qapi: Add blank lines before " Peter Maydell
` (17 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders in the HTML and manpage like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
This commit gathers up the remaining json files which had
places needing this fix.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block.json | 33 ++++++++++++++-------------------
qapi/misc.json | 36 ++++++++++++++++--------------------
qapi/tpm.json | 4 ++--
3 files changed, 32 insertions(+), 41 deletions(-)
diff --git a/qapi/block.json b/qapi/block.json
index 905297bab2e..e509cc53506 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -115,15 +115,12 @@
#
# For the arguments, see the documentation of BlockdevSnapshotInternal.
#
-# Returns: nothing on success
-#
-# If @device is not a valid block device, GenericError
-#
-# If any snapshot matching @name exists, or @name is empty,
-# GenericError
-#
-# If the format of the image used does not support it,
-# BlockFormatFeatureNotSupported
+# Returns: - nothing on success
+# - If @device is not a valid block device, GenericError
+# - If any snapshot matching @name exists, or @name is empty,
+# GenericError
+# - If the format of the image used does not support it,
+# BlockFormatFeatureNotSupported
#
# Since: 1.7
#
@@ -154,12 +151,12 @@
#
# @name: optional the snapshot's name to be deleted
#
-# Returns: SnapshotInfo on success
-# If @device is not a valid block device, GenericError
-# If snapshot not found, GenericError
-# If the format of the image used does not support it,
-# BlockFormatFeatureNotSupported
-# If @id and @name are both not specified, GenericError
+# Returns: - SnapshotInfo on success
+# - If @device is not a valid block device, GenericError
+# - If snapshot not found, GenericError
+# - If the format of the image used does not support it,
+# BlockFormatFeatureNotSupported
+# - If @id and @name are both not specified, GenericError
#
# Since: 1.7
#
@@ -197,10 +194,8 @@
# @force: If true, eject regardless of whether the drive is locked.
# If not specified, the default value is false.
#
-# Returns: Nothing on success
-#
-# If @device is not a valid block device, DeviceNotFound
-#
+# Returns: - Nothing on success
+# - If @device is not a valid block device, DeviceNotFound
# Notes: Ejecting a device with no media results in success
#
# Since: 0.14.0
diff --git a/qapi/misc.json b/qapi/misc.json
index 626a342b008..06c80b58a24 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -418,12 +418,10 @@
#
# Return information about the balloon device.
#
-# Returns: @BalloonInfo on success
-#
-# If the balloon driver is enabled but not functional because the KVM
-# kernel module cannot support it, KvmMissingCap
-#
-# If no balloon device is present, DeviceNotActive
+# Returns: - @BalloonInfo on success
+# - If the balloon driver is enabled but not functional because the KVM
+# kernel module cannot support it, KvmMissingCap
+# - If no balloon device is present, DeviceNotActive
#
# Since: 0.14.0
#
@@ -480,8 +478,8 @@
#
# @bar: the index of the Base Address Register for this region
#
-# @type: 'io' if the region is a PIO region
-# 'memory' if the region is a MMIO region
+# @type: - 'io' if the region is a PIO region
+# - 'memory' if the region is a MMIO region
#
# @size: memory size
#
@@ -992,10 +990,10 @@
#
# @value: the target size of the balloon in bytes
#
-# Returns: Nothing on success
-# If the balloon driver is enabled but not functional because the KVM
+# Returns: - Nothing on success
+# - If the balloon driver is enabled but not functional because the KVM
# kernel module cannot support it, KvmMissingCap
-# If no balloon device is present, DeviceNotActive
+# - If no balloon device is present, DeviceNotActive
#
# Notes: This command just issues a request to the guest. When it returns,
# the balloon size may not have changed. A guest can change the balloon
@@ -1074,8 +1072,8 @@
# If @device is 'vnc' and @target is 'password', this is the new VNC
# password to set. See change-vnc-password for additional notes.
#
-# Returns: Nothing on success.
-# If @device is not a valid block device, DeviceNotFound
+# Returns: - Nothing on success.
+# - If @device is not a valid block device, DeviceNotFound
#
# Notes: This interface is deprecated, and it is strongly recommended that you
# avoid using it. For changing block devices, use
@@ -1225,11 +1223,9 @@
#
# @opaque: A free-form string that can be used to describe the fd.
#
-# Returns: @AddfdInfo on success
-#
-# If file descriptor was not received, FdNotSupplied
-#
-# If @fdset-id is a negative value, InvalidParameterValue
+# Returns: - @AddfdInfo on success
+# - If file descriptor was not received, FdNotSupplied
+# - If @fdset-id is a negative value, InvalidParameterValue
#
# Notes: The list of fd sets is shared by all monitor connections.
#
@@ -1257,8 +1253,8 @@
#
# @fd: The file descriptor that is to be removed.
#
-# Returns: Nothing on success
-# If @fdset-id or @fd is not found, FdNotFound
+# Returns: - Nothing on success
+# - If @fdset-id or @fd is not found, FdNotFound
#
# Since: 1.2.0
#
diff --git a/qapi/tpm.json b/qapi/tpm.json
index 63878aa0f47..dc1f0817399 100644
--- a/qapi/tpm.json
+++ b/qapi/tpm.json
@@ -96,8 +96,8 @@
#
# A union referencing different TPM backend types' configuration options
#
-# @type: 'passthrough' The configuration options for the TPM passthrough type
-# 'emulator' The configuration options for TPM emulator backend type
+# @type: - 'passthrough' The configuration options for the TPM passthrough type
+# - 'emulator' The configuration options for TPM emulator backend type
#
# Since: 1.5
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 16/29] qapi/{block, misc, tmp}.json: Use explicit bulleted lists
2020-02-06 17:30 ` [PATCH 16/29] qapi/{block, misc, tmp}.json: " Peter Maydell
@ 2020-02-07 10:33 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 77+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-02-07 10:33 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: John Snow, Daniel P. Berrangé,
Markus Armbruster, Stefan Hajnoczi, Michael Roth
On 2/6/20 6:30 PM, Peter Maydell wrote:
> A JSON block comment like this:
> Returns: nothing on success
> If @node is not a valid block device, DeviceNotFound
> If @name is not found, GenericError with an explanation
>
> renders in the HTML and manpage like this:
>
> Returns: nothing on success If node is not a valid block device,
> DeviceNotFound If name is not found, GenericError with an explanation
>
> because whitespace is not significant.
>
> Use an actual bulleted list, so that the formatting is correct.
>
> This commit gathers up the remaining json files which had
> places needing this fix.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/block.json | 33 ++++++++++++++-------------------
> qapi/misc.json | 36 ++++++++++++++++--------------------
> qapi/tpm.json | 4 ++--
> 3 files changed, 32 insertions(+), 41 deletions(-)
>
> diff --git a/qapi/block.json b/qapi/block.json
> index 905297bab2e..e509cc53506 100644
> --- a/qapi/block.json
> +++ b/qapi/block.json
> @@ -115,15 +115,12 @@
> #
> # For the arguments, see the documentation of BlockdevSnapshotInternal.
> #
> -# Returns: nothing on success
> -#
> -# If @device is not a valid block device, GenericError
> -#
> -# If any snapshot matching @name exists, or @name is empty,
> -# GenericError
> -#
> -# If the format of the image used does not support it,
> -# BlockFormatFeatureNotSupported
> +# Returns: - nothing on success
> +# - If @device is not a valid block device, GenericError
> +# - If any snapshot matching @name exists, or @name is empty,
> +# GenericError
> +# - If the format of the image used does not support it,
> +# BlockFormatFeatureNotSupported
> #
> # Since: 1.7
> #
> @@ -154,12 +151,12 @@
> #
> # @name: optional the snapshot's name to be deleted
> #
> -# Returns: SnapshotInfo on success
> -# If @device is not a valid block device, GenericError
> -# If snapshot not found, GenericError
> -# If the format of the image used does not support it,
> -# BlockFormatFeatureNotSupported
> -# If @id and @name are both not specified, GenericError
> +# Returns: - SnapshotInfo on success
> +# - If @device is not a valid block device, GenericError
> +# - If snapshot not found, GenericError
> +# - If the format of the image used does not support it,
> +# BlockFormatFeatureNotSupported
> +# - If @id and @name are both not specified, GenericError
> #
> # Since: 1.7
> #
> @@ -197,10 +194,8 @@
> # @force: If true, eject regardless of whether the drive is locked.
> # If not specified, the default value is false.
> #
> -# Returns: Nothing on success
> -#
> -# If @device is not a valid block device, DeviceNotFound
> -#
> +# Returns: - Nothing on success
> +# - If @device is not a valid block device, DeviceNotFound
> # Notes: Ejecting a device with no media results in success
> #
> # Since: 0.14.0
> diff --git a/qapi/misc.json b/qapi/misc.json
> index 626a342b008..06c80b58a24 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -418,12 +418,10 @@
> #
> # Return information about the balloon device.
> #
> -# Returns: @BalloonInfo on success
> -#
> -# If the balloon driver is enabled but not functional because the KVM
> -# kernel module cannot support it, KvmMissingCap
> -#
> -# If no balloon device is present, DeviceNotActive
> +# Returns: - @BalloonInfo on success
> +# - If the balloon driver is enabled but not functional because the KVM
> +# kernel module cannot support it, KvmMissingCap
> +# - If no balloon device is present, DeviceNotActive
> #
> # Since: 0.14.0
> #
> @@ -480,8 +478,8 @@
> #
> # @bar: the index of the Base Address Register for this region
> #
> -# @type: 'io' if the region is a PIO region
> -# 'memory' if the region is a MMIO region
> +# @type: - 'io' if the region is a PIO region
> +# - 'memory' if the region is a MMIO region
> #
> # @size: memory size
> #
> @@ -992,10 +990,10 @@
> #
> # @value: the target size of the balloon in bytes
> #
> -# Returns: Nothing on success
> -# If the balloon driver is enabled but not functional because the KVM
> +# Returns: - Nothing on success
> +# - If the balloon driver is enabled but not functional because the KVM
> # kernel module cannot support it, KvmMissingCap
> -# If no balloon device is present, DeviceNotActive
> +# - If no balloon device is present, DeviceNotActive
> #
> # Notes: This command just issues a request to the guest. When it returns,
> # the balloon size may not have changed. A guest can change the balloon
> @@ -1074,8 +1072,8 @@
> # If @device is 'vnc' and @target is 'password', this is the new VNC
> # password to set. See change-vnc-password for additional notes.
> #
> -# Returns: Nothing on success.
> -# If @device is not a valid block device, DeviceNotFound
> +# Returns: - Nothing on success.
> +# - If @device is not a valid block device, DeviceNotFound
> #
> # Notes: This interface is deprecated, and it is strongly recommended that you
> # avoid using it. For changing block devices, use
> @@ -1225,11 +1223,9 @@
> #
> # @opaque: A free-form string that can be used to describe the fd.
> #
> -# Returns: @AddfdInfo on success
> -#
> -# If file descriptor was not received, FdNotSupplied
> -#
> -# If @fdset-id is a negative value, InvalidParameterValue
> +# Returns: - @AddfdInfo on success
> +# - If file descriptor was not received, FdNotSupplied
> +# - If @fdset-id is a negative value, InvalidParameterValue
> #
> # Notes: The list of fd sets is shared by all monitor connections.
> #
> @@ -1257,8 +1253,8 @@
> #
> # @fd: The file descriptor that is to be removed.
> #
> -# Returns: Nothing on success
> -# If @fdset-id or @fd is not found, FdNotFound
> +# Returns: - Nothing on success
> +# - If @fdset-id or @fd is not found, FdNotFound
> #
> # Since: 1.2.0
> #
> diff --git a/qapi/tpm.json b/qapi/tpm.json
> index 63878aa0f47..dc1f0817399 100644
> --- a/qapi/tpm.json
> +++ b/qapi/tpm.json
> @@ -96,8 +96,8 @@
> #
> # A union referencing different TPM backend types' configuration options
> #
> -# @type: 'passthrough' The configuration options for the TPM passthrough type
> -# 'emulator' The configuration options for TPM emulator backend type
> +# @type: - 'passthrough' The configuration options for the TPM passthrough type
> +# - 'emulator' The configuration options for TPM emulator backend type
> #
> # Since: 1.5
> ##
>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 17/29] qapi: Add blank lines before bulleted lists
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (15 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 16/29] qapi/{block, misc, tmp}.json: " Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 10:11 ` Philippe Mathieu-Daudé
2020-02-06 17:30 ` [PATCH 18/29] qapi/migration.json: Replace _this_ with *this* Peter Maydell
` (16 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
rST insists on a blank line before and after a bulleted list,
but our texinfo doc generator did not. Add some extra blank
lines in the doc comments so they're acceptable rST input.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 1 +
qapi/char.json | 2 ++
qapi/trace.json | 1 +
qapi/ui.json | 1 +
4 files changed, 5 insertions(+)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 9e878e39336..092cd8f13d9 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -4757,6 +4757,7 @@
#
# Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
# which no such event will be generated, these include:
+#
# - if the guest has locked the tray, @force is false and the guest does not
# respond to the eject request
# - if the BlockBackend denoted by @device does not have a guest device attached
diff --git a/qapi/char.json b/qapi/char.json
index 8a9f1e75097..6907b2bfdba 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -133,6 +133,7 @@
# @data: data to write
#
# @format: data encoding (default 'utf8').
+#
# - base64: data must be base64 encoded text. Its binary
# decoding gets written.
# - utf8: data's UTF-8 encoding is written
@@ -167,6 +168,7 @@
# @size: how many bytes to read at most
#
# @format: data encoding (default 'utf8').
+#
# - base64: the data read is returned in base64 encoding.
# - utf8: the data read is interpreted as UTF-8.
# Bug: can screw up when the buffer contains invalid UTF-8
diff --git a/qapi/trace.json b/qapi/trace.json
index 4955e5a7503..47c68f04da7 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -53,6 +53,7 @@
# Returns: a list of @TraceEventInfo for the matching events
#
# An event is returned if:
+#
# - its name matches the @name pattern, and
# - if @vcpu is given, the event has the "vcpu" property.
#
diff --git a/qapi/ui.json b/qapi/ui.json
index f527bbdc26e..b368401fd1d 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -935,6 +935,7 @@
# Input event union.
#
# @type: the input type, one of:
+#
# - 'key': Input event of Keyboard
# - 'btn': Input event of pointer buttons
# - 'rel': Input event of relative pointer motion
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 17/29] qapi: Add blank lines before bulleted lists
2020-02-06 17:30 ` [PATCH 17/29] qapi: Add blank lines before " Peter Maydell
@ 2020-02-07 10:11 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 77+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-02-07 10:11 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: John Snow, Daniel P. Berrangé,
Markus Armbruster, Stefan Hajnoczi, Michael Roth
On 2/6/20 6:30 PM, Peter Maydell wrote:
> rST insists on a blank line before and after a bulleted list,
> but our texinfo doc generator did not. Add some extra blank
> lines in the doc comments so they're acceptable rST input.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/block-core.json | 1 +
> qapi/char.json | 2 ++
> qapi/trace.json | 1 +
> qapi/ui.json | 1 +
> 4 files changed, 5 insertions(+)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 9e878e39336..092cd8f13d9 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -4757,6 +4757,7 @@
> #
> # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
> # which no such event will be generated, these include:
> +#
> # - if the guest has locked the tray, @force is false and the guest does not
> # respond to the eject request
> # - if the BlockBackend denoted by @device does not have a guest device attached
> diff --git a/qapi/char.json b/qapi/char.json
> index 8a9f1e75097..6907b2bfdba 100644
> --- a/qapi/char.json
> +++ b/qapi/char.json
> @@ -133,6 +133,7 @@
> # @data: data to write
> #
> # @format: data encoding (default 'utf8').
> +#
> # - base64: data must be base64 encoded text. Its binary
> # decoding gets written.
> # - utf8: data's UTF-8 encoding is written
> @@ -167,6 +168,7 @@
> # @size: how many bytes to read at most
> #
> # @format: data encoding (default 'utf8').
> +#
> # - base64: the data read is returned in base64 encoding.
> # - utf8: the data read is interpreted as UTF-8.
> # Bug: can screw up when the buffer contains invalid UTF-8
> diff --git a/qapi/trace.json b/qapi/trace.json
> index 4955e5a7503..47c68f04da7 100644
> --- a/qapi/trace.json
> +++ b/qapi/trace.json
> @@ -53,6 +53,7 @@
> # Returns: a list of @TraceEventInfo for the matching events
> #
> # An event is returned if:
> +#
> # - its name matches the @name pattern, and
> # - if @vcpu is given, the event has the "vcpu" property.
> #
> diff --git a/qapi/ui.json b/qapi/ui.json
> index f527bbdc26e..b368401fd1d 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -935,6 +935,7 @@
> # Input event union.
> #
> # @type: the input type, one of:
> +#
> # - 'key': Input event of Keyboard
> # - 'btn': Input event of pointer buttons
> # - 'rel': Input event of relative pointer motion
>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (16 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 17/29] qapi: Add blank lines before " Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 16:54 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
` (15 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
The MigrationInfo::setup-time documentation is the only place where
we use _this_ inline markup to mean italics. rST doesn't recognize
that markup and emits literal underscores. Switch to *this* instead;
for the texinfo output this will be bold, and for rST it will go back
to being italics.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/migration.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index 11033b7a8e6..52f34299698 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -178,8 +178,8 @@
# expected downtime in milliseconds for the guest in last walk
# of the dirty bitmap. (since 1.3)
#
-# @setup-time: amount of setup time in milliseconds _before_ the
-# iterations begin but _after_ the QMP command is issued. This is designed
+# @setup-time: amount of setup time in milliseconds *before* the
+# iterations begin but *after* the QMP command is issued. This is designed
# to provide an accounting of any activities (such as RDMA pinning) which
# may be expensive, but do not actually occur during the iterative
# migration rounds themselves. (since 1.6)
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*
2020-02-06 17:30 ` [PATCH 18/29] qapi/migration.json: Replace _this_ with *this* Peter Maydell
@ 2020-02-07 16:54 ` Markus Armbruster
2020-02-07 17:00 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 16:54 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> The MigrationInfo::setup-time documentation is the only place where
> we use _this_ inline markup to mean italics.
Nitpick: _this_ does not mean italics, it means emphasis. See
qapi-code-gen.txt section "Documentation markup". doc.py maps it to
@emph{this}, which Texinfo commonly renders in italics when the output
format supports that.
> rST doesn't recognize
> that markup and emits literal underscores. Switch to *this* instead;
> for the texinfo output this will be bold, and for rST it will go back
> to being italics.
Likewise, *this* doesn't mean italics in rST, it means emphasis.
With the Texinfo doc pipeline, the patch changes the markup of this from
emphasis to strong.
The change will be undone when we switch to rST, where it means emphasis
again.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/migration.json | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/migration.json b/qapi/migration.json
> index 11033b7a8e6..52f34299698 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -178,8 +178,8 @@
> # expected downtime in milliseconds for the guest in last walk
> # of the dirty bitmap. (since 1.3)
> #
> -# @setup-time: amount of setup time in milliseconds _before_ the
> -# iterations begin but _after_ the QMP command is issued. This is designed
> +# @setup-time: amount of setup time in milliseconds *before* the
> +# iterations begin but *after* the QMP command is issued. This is designed
> # to provide an accounting of any activities (such as RDMA pinning) which
> # may be expensive, but do not actually occur during the iterative
> # migration rounds themselves. (since 1.6)
I don't like the commit message, but that's not enough to withhold my
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*
2020-02-07 16:54 ` Markus Armbruster
@ 2020-02-07 17:00 ` Peter Maydell
2020-02-08 14:24 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 17:00 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 16:54, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > The MigrationInfo::setup-time documentation is the only place where
> > we use _this_ inline markup to mean italics.
>
> Nitpick: _this_ does not mean italics, it means emphasis. See
> qapi-code-gen.txt section "Documentation markup". doc.py maps it to
> @emph{this}, which Texinfo commonly renders in italics when the output
> format supports that.
Yeah, I know. But to my mind nobody actually cares about "is this
'emphasis' or 'strong'", because those are pretty meaningless
and are not very easy to distinguish semantically. What people
actually care about is "how does this render", because bold and
italics look noticeably different and if you're writing you
might care about which you get. At that point 'strong' is just
a confusing synonym for 'bold' and 'emphasis' is a confusing
synonym for 'italics'. But maybe I'm out on a limb here.
Anyway, I'm happy to tweak the commit message.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*
2020-02-07 17:00 ` Peter Maydell
@ 2020-02-08 14:24 ` Markus Armbruster
0 siblings, 0 replies; 77+ messages in thread
From: Markus Armbruster @ 2020-02-08 14:24 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 16:54, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > The MigrationInfo::setup-time documentation is the only place where
>> > we use _this_ inline markup to mean italics.
>>
>> Nitpick: _this_ does not mean italics, it means emphasis. See
>> qapi-code-gen.txt section "Documentation markup". doc.py maps it to
>> @emph{this}, which Texinfo commonly renders in italics when the output
>> format supports that.
>
> Yeah, I know. But to my mind nobody actually cares about "is this
> 'emphasis' or 'strong'", because those are pretty meaningless
> and are not very easy to distinguish semantically. What people
> actually care about is "how does this render", because bold and
> italics look noticeably different and if you're writing you
> might care about which you get. At that point 'strong' is just
> a confusing synonym for 'bold' and 'emphasis' is a confusing
> synonym for 'italics'. But maybe I'm out on a limb here.
>
> Anyway, I'm happy to tweak the commit message.
What about this:
qapi/migration.json: Replace _this_ with *this*
The MigrationInfo::setup-time documentation is the only place where
we use _this_ inline markup for emphasis, commonly rendered in
italics. rST doesn't recognize that markup and emits literal
underscores.
Switch to *this* instead. Changes markup to strong emphasis with
Texinfo, commonly rendered as bold. With rST, it will go right back
to emphasis / italics.
I tried to cater both for semantic markup wonks and happy visual
ignorants ;)
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (17 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 18/29] qapi/migration.json: Replace _this_ with *this* Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-07 15:34 ` Markus Armbruster
2020-02-06 17:30 ` [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment Peter Maydell
` (14 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Our current QAPI doc-comment markup allows section headers
(introduced with a leading '=' or '==') anywhere in any documentation
comment. This works for texinfo because the texi generator simply
prints a texinfo heading directive at that point in the output
stream. For rST generation, since we're assembling a tree of
docutils nodes, this is awkward because a new section implies
starting a new section node at the top level of the tree and
generating text into there.
New section headings in the middle of the documentation of a command
or event would be pretty nonsensical, and in fact we only ever output
new headings using 'freeform' doc comment blocks whose only content
is the single line of the heading, with two exceptions, which are in
the introductory freeform-doc-block at the top of
qapi/qapi-schema.json.
Split that doc-comment up so that the heading lines are in their own
doc-comment. This will allow us to tighten the specification to
insist that heading lines are always standalone, rather than
requiring the rST document generator to look at every line in a doc
comment block and handle headings in odd places.
This change makes no difference to the generated texi.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/qapi-schema.json | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index 9751b11f8f1..f7ba60a5d0b 100644
--- a/qapi/qapi-schema.json
+++ b/qapi/qapi-schema.json
@@ -1,7 +1,9 @@
# -*- Mode: Python -*-
##
# = Introduction
-#
+##
+
+##
# This document describes all commands currently supported by QMP.
#
# Most of the time their usage is exactly the same as in the user Monitor, this
@@ -25,9 +27,13 @@
#
# Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for
# detailed information on the Server command and response formats.
-#
+##
+
+##
# = Stability Considerations
-#
+##
+
+##
# The current QMP command set (described in this file) may be useful for a
# number of use cases, however it's limited and several commands have bad
# defined semantics, specially with regard to command completion.
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks
2020-02-06 17:30 ` [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
@ 2020-02-07 15:34 ` Markus Armbruster
2020-02-07 16:13 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 15:34 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> Our current QAPI doc-comment markup allows section headers
> (introduced with a leading '=' or '==') anywhere in any documentation
> comment. This works for texinfo because the texi generator simply
> prints a texinfo heading directive at that point in the output
> stream. For rST generation, since we're assembling a tree of
> docutils nodes, this is awkward because a new section implies
> starting a new section node at the top level of the tree and
> generating text into there.
>
> New section headings in the middle of the documentation of a command
> or event would be pretty nonsensical, and in fact we only ever output
> new headings using 'freeform' doc comment blocks whose only content
> is the single line of the heading, with two exceptions, which are in
> the introductory freeform-doc-block at the top of
> qapi/qapi-schema.json.
>
> Split that doc-comment up so that the heading lines are in their own
> doc-comment. This will allow us to tighten the specification to
> insist that heading lines are always standalone, rather than
> requiring the rST document generator to look at every line in a doc
> comment block and handle headings in odd places.
>
> This change makes no difference to the generated texi.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qapi/qapi-schema.json | 12 +++++++++---
> 1 file changed, 9 insertions(+), 3 deletions(-)
>
> diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
> index 9751b11f8f1..f7ba60a5d0b 100644
> --- a/qapi/qapi-schema.json
> +++ b/qapi/qapi-schema.json
> @@ -1,7 +1,9 @@
> # -*- Mode: Python -*-
> ##
> # = Introduction
> -#
> +##
> +
> +##
> # This document describes all commands currently supported by QMP.
> #
> # Most of the time their usage is exactly the same as in the user Monitor, this
> @@ -25,9 +27,13 @@
> #
> # Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for
> # detailed information on the Server command and response formats.
> -#
> +##
> +
> +##
> # = Stability Considerations
> -#
> +##
> +
> +##
> # The current QMP command set (described in this file) may be useful for a
> # number of use cases, however it's limited and several commands have bad
> # defined semantics, specially with regard to command completion.
I figure this is a minimally invasive patch to avoid complications in
your rST generator. I'm afraid it sweeps the actual problem under the
rug, namely flaws in our parsing and representation of doc comments.
The doc comment parser doesn't recognize headings. Instead, that's done
somewhere in the bowels of the Texinfo generator. Works as long as the
input is "sane", happily generates invalid Texinfo otherwise, see
tests/qapi-schema/doc-bad-section.json.
The proper fix is to make the parser recognize headers in the places
where headers make sense, and reject them elsewhere.
But maybe we don't have to. Do you plan to support full rST in doc
comments? If yes, why have our own syntax for headings? Why not leave
it to rST? If no, do you plan to support a subset of rST? If yes,
define it, please. How will it be enforced?
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks
2020-02-07 15:34 ` Markus Armbruster
@ 2020-02-07 16:13 ` Peter Maydell
2020-02-08 14:10 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 16:13 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 15:35, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > Our current QAPI doc-comment markup allows section headers
> > (introduced with a leading '=' or '==') anywhere in any documentation
> > comment. This works for texinfo because the texi generator simply
> > prints a texinfo heading directive at that point in the output
> > stream. For rST generation, since we're assembling a tree of
> > docutils nodes, this is awkward because a new section implies
> > starting a new section node at the top level of the tree and
> > generating text into there.
> >
> > New section headings in the middle of the documentation of a command
> > or event would be pretty nonsensical, and in fact we only ever output
> > new headings using 'freeform' doc comment blocks whose only content
> > is the single line of the heading, with two exceptions, which are in
> > the introductory freeform-doc-block at the top of
> > qapi/qapi-schema.json.
> >
> > Split that doc-comment up so that the heading lines are in their own
> > doc-comment. This will allow us to tighten the specification to
> > insist that heading lines are always standalone, rather than
> > requiring the rST document generator to look at every line in a doc
> > comment block and handle headings in odd places.
> I figure this is a minimally invasive patch to avoid complications in
> your rST generator. I'm afraid it sweeps the actual problem under the
> rug, namely flaws in our parsing and representation of doc comments.
>
> The doc comment parser doesn't recognize headings. Instead, that's done
> somewhere in the bowels of the Texinfo generator. Works as long as the
> input is "sane", happily generates invalid Texinfo otherwise, see
> tests/qapi-schema/doc-bad-section.json.
>
> The proper fix is to make the parser recognize headers in the places
> where headers make sense, and reject them elsewhere.
>
> But maybe we don't have to. Do you plan to support full rST in doc
> comments? If yes, why have our own syntax for headings? Why not leave
> it to rST? If no, do you plan to support a subset of rST? If yes,
> define it, please. How will it be enforced?
Doc comments do support full rST. However, (as the commit message
here notes), if you're generating a tree of docutils nodes and
one of them has a section heading in it then you'll get a result
that looks like this:
[root]
- [ some section created by the script for a QAPI command ]
- [ some section ]
- [text nodes, etc going into this section]
- [a section resulting from rST parsing the header inside the docstring]
- [ next section created by the script for a QAPI command ]
(ie you'll have defined a subsection within whatever document
paragraph/section the current command is documenting, not
a new top-level subsection which subsequent commands will
become children of)
What you actually want is that the new header results in
a differently structured tree:
[root]
- [ some section created by the script for a QAPI command ]
- [ some section ]
- [text nodes, etc going into this section]
- [ a new top level section whose header is whatever this header is ]
- [ next section created by the script is a child of that section ]
- [ etc ]
There's no way to get that without actually noticing and handling
headings specially as being something entirely different from
a lump of documentation text. "A heading is a single-line special-case
of a freeform comment" happens to be the way we mark up headings
now in 99% of cases, so that's what I implemented. (The Sphinx
extension will complain if there's trailing junk lines after
a heading line at the beginning of a freeform comment block.
If you use '== something' in a line in the middle of a doc
comment, we'll just interpret that as rST source, which is to
say a couple of literal equals signs at the start of a line.)
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks
2020-02-07 16:13 ` Peter Maydell
@ 2020-02-08 14:10 ` Markus Armbruster
2020-02-08 14:43 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-08 14:10 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 15:35, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > Our current QAPI doc-comment markup allows section headers
>> > (introduced with a leading '=' or '==') anywhere in any documentation
>> > comment. This works for texinfo because the texi generator simply
>> > prints a texinfo heading directive at that point in the output
>> > stream. For rST generation, since we're assembling a tree of
>> > docutils nodes, this is awkward because a new section implies
>> > starting a new section node at the top level of the tree and
>> > generating text into there.
>> >
>> > New section headings in the middle of the documentation of a command
>> > or event would be pretty nonsensical, and in fact we only ever output
>> > new headings using 'freeform' doc comment blocks whose only content
>> > is the single line of the heading, with two exceptions, which are in
>> > the introductory freeform-doc-block at the top of
>> > qapi/qapi-schema.json.
>> >
>> > Split that doc-comment up so that the heading lines are in their own
>> > doc-comment. This will allow us to tighten the specification to
>> > insist that heading lines are always standalone, rather than
>> > requiring the rST document generator to look at every line in a doc
>> > comment block and handle headings in odd places.
>
>> I figure this is a minimally invasive patch to avoid complications in
>> your rST generator. I'm afraid it sweeps the actual problem under the
>> rug, namely flaws in our parsing and representation of doc comments.
>>
>> The doc comment parser doesn't recognize headings. Instead, that's done
>> somewhere in the bowels of the Texinfo generator. Works as long as the
>> input is "sane", happily generates invalid Texinfo otherwise, see
>> tests/qapi-schema/doc-bad-section.json.
>>
>> The proper fix is to make the parser recognize headers in the places
>> where headers make sense, and reject them elsewhere.
>>
>> But maybe we don't have to. Do you plan to support full rST in doc
>> comments? If yes, why have our own syntax for headings? Why not leave
>> it to rST? If no, do you plan to support a subset of rST? If yes,
>> define it, please. How will it be enforced?
>
> Doc comments do support full rST. However, (as the commit message
> here notes), if you're generating a tree of docutils nodes and
> one of them has a section heading in it then you'll get a result
> that looks like this:
>
> [root]
> - [ some section created by the script for a QAPI command ]
> - [ some section ]
> - [text nodes, etc going into this section]
> - [a section resulting from rST parsing the header inside the docstring]
> - [ next section created by the script for a QAPI command ]
>
> (ie you'll have defined a subsection within whatever document
> paragraph/section the current command is documenting, not
> a new top-level subsection which subsequent commands will
> become children of)
>
> What you actually want is that the new header results in
> a differently structured tree:
> [root]
> - [ some section created by the script for a QAPI command ]
> - [ some section ]
> - [text nodes, etc going into this section]
> - [ a new top level section whose header is whatever this header is ]
> - [ next section created by the script is a child of that section ]
> - [ etc ]
>
> There's no way to get that without actually noticing and handling
> headings specially as being something entirely different from
> a lump of documentation text. "A heading is a single-line special-case
> of a freeform comment" happens to be the way we mark up headings
> now in 99% of cases, so that's what I implemented. (The Sphinx
> extension will complain if there's trailing junk lines after
> a heading line at the beginning of a freeform comment block.
> If you use '== something' in a line in the middle of a doc
> comment, we'll just interpret that as rST source, which is to
> say a couple of literal equals signs at the start of a line.)
A couple of remarks.
Silently passing a "# == something" line to rST for literal
(mis-)interpretation is not nice. It's the kind of indifference that
led to the messes you cleaned up in PATCH 04 and 08. If the '=' markup
is only valid in certain places, it should be rejected where it isn't.
By refusing to translate "# == something" to rST (silently or loudly,
doesn't matter), the first tree structure becomes impossible. Except
when I do the translating myself: I can put an *rST* section wherever I
want.
I'm still having difficulties understanding what exactly we gain by
translating '=' markup to rST.
By the way, your implementation rejects
##
# = Introduction
# xxx
##
but silently accepts
##
# xxx
# = Introduction
##
doc-good.json has more instances of this issue. Before your series, we
actually check we generate the Texinfo we expect for it. I can't find
where you cover this now. It has saved me from my screwups more than
once, so I don't want to lose that.
Now let's put my doubts and your possible bugs / omissions aside and
assume we want '=' markup, and we want to keep the resulting sections
out of "sections created by the script for a QAPI command".
A schema's documentation is a sequence of comment blocks.
Each comment block is either a definition comment block or a free form
comment block.
Before your series, we recognize '=' markup everywhere, but that's
basically wrong (see "flaws in our parsing and representation of doc
comments" above). It should be accepted only in free-form comment
blocks.
That way, the free-form comment blocks build a section structure, and
the definition comment blocks slot their stuff into this structure.
Form a language design perspective, I can't see the need for restricting
'=' further to occur only by themselves.
Is it an issue of implementation perhaps?
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks
2020-02-08 14:10 ` Markus Armbruster
@ 2020-02-08 14:43 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-08 14:43 UTC (permalink / raw)
To: Markus Armbruster
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
On Sat, 8 Feb 2020 at 14:10, Markus Armbruster <armbru@redhat.com> wrote:
> A couple of remarks.
>
> Silently passing a "# == something" line to rST for literal
> (mis-)interpretation is not nice. It's the kind of indifference that
> led to the messes you cleaned up in PATCH 04 and 08. If the '=' markup
> is only valid in certain places, it should be rejected where it isn't.
>
> By refusing to translate "# == something" to rST (silently or loudly,
> doesn't matter), the first tree structure becomes impossible. Except
> when I do the translating myself: I can put an *rST* section wherever I
> want.
>
> I'm still having difficulties understanding what exactly we gain by
> translating '=' markup to rST.
We don't translate '=' markup to rST. We use it as the way
the input document tells us about the structure of the
tree of docutils sections it wants us to create. No rST
markup is ever involved in that process.
If we wanted to do something with '# == something' in actual
chunks of doc comment, we would have to specifically scan
the doc comment for that. Currently we simply pass doc
comments to the rST parser to be parsed. Then you have
to document the syntax of a doc comment as "rST, except
that as a special case a line starting == doesn't do what
it does in normal rST text but is a syntax error".
What I would like is:
* doc comments are simply rST, and we interpret them as
rST by passing them directly to the rST parser. (We do
special case the "@var means ``var``" markup, but I
would rather keep to a minimum the number of things we
special case in that way.)
* headings and subheadings affect the entire document
structure; they are not rST source and are never
interpreted as rST source or sent to the rST parser.
They are a thing all of their own, not a bit of markup
within a larger doc comment.
* not to gratuitously change the way we in practice
mark up headings in our document, because that makes
the texi->rST transition harder for no clear gain.
If we absolutely must mark them up in some other way
than we do today, I can implement that, but it feels
like unnecessary work.
> By the way, your implementation rejects
>
> ##
> # = Introduction
> # xxx
> ##
>
> but silently accepts
>
> ##
> # xxx
> # = Introduction
> ##
Yes. I could treat all freeform comments that aren't
the special one-line heading/subheading as being normal
freeform comments, which would avoid this inconsistency.
That's probably better.
> doc-good.json has more instances of this issue. Before your series, we
> actually check we generate the Texinfo we expect for it. I can't find
> where you cover this now. It has saved me from my screwups more than
> once, so I don't want to lose that.
Yes, we no longer have a test case for "do we generate what we
expect to". That's harder to do with a Sphinx extension because
we don't ever output rST source anywhere that we could compare
to an expected version. (We still have the existing tests that
the doc comments spit out by parser.py match expected output.)
I'm dubious about running Sphinx and comparing the generated HTML
because that seems like it would be vulnerable to test failures
if Sphinx internals change the fine detail of how it outputs HTML.
> Now let's put my doubts and your possible bugs / omissions aside and
> assume we want '=' markup, and we want to keep the resulting sections
> out of "sections created by the script for a QAPI command".
>
> A schema's documentation is a sequence of comment blocks.
>
> Each comment block is either a definition comment block or a free form
> comment block.
>
> Before your series, we recognize '=' markup everywhere, but that's
> basically wrong (see "flaws in our parsing and representation of doc
> comments" above). It should be accepted only in free-form comment
> blocks.
>
> That way, the free-form comment blocks build a section structure, and
> the definition comment blocks slot their stuff into this structure.
>
> Form a language design perspective, I can't see the need for restricting
> '=' further to occur only by themselves.
>
> Is it an issue of implementation perhaps?
Do you mean: could we make the implementation take a freeform
comment block like:
##
# = Foo
#
# Some text
#
# = Bar
#
# More text
##
and parse through that text to split it up into
- "start new level-1 section with heading 'Foo'"
- "a freeform comment block '\nSome text\n\n'" (for current section)
- "start new level-1 section with heading 'Bar'"
- "a freeform comment block '\nMore text\n\n'" (for current section)
so that the input rST doesn't need to mark off the headings
as being in their own freeform comment block ?
Yes, we could do that, and it wouldn't be too hard.
My issues with that are:
(1) you now don't have a way to literally write '= Foo'
to be interpreted the way that rST would interpret it
in a comment block that's otherwise just "any
rST markup is fine".
(2) it falsely suggests that headings are OK in
doc comment blocks and are just another kind of
markup within a doc comment, when they aren't, and
we're really just providing syntactic sugar here
(3) it obscures the actual structure of the
document, which is
[root node]
[section]
[title 'Foo']
[Text 'Some text']
[section]
[title 'Bar']
[Text 'More text']
where "Some text" and "More text" are in entirely
different sections, even though they're in the same
doc comment block. (If 'Foo' is a subsection and
'Bar' a section, the text can end up even further
separated within the document tree.)
(4) it breaks a general approach within the handling
of doc comments, which is that we build the document
based on the various bits of information about the
symbol, etc, but a chunk of text from a document
comment is handled simply by handing it off to
the rST parser, not by doing some script-specific
pre-parsing and mangling of it and then handing it
to the rST parser. This in turn means that we need
to document the syntax of comment blocks as not
just "it's rST with the @var-means-``var`` extra"
but "it's rST, with @var-means-``var``, and = Foo
is invalid most places but within a freeform block
means this other thing". I think that minimising
the number of extras we add on top of "the syntax
for a block of text in a doc comment is rST"
makes things less confusing.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (18 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
` (13 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
For rST, '*' is a kind of inline markup (for emphasis), so
"*-softmmu" is a syntax error because of the missing closing '*'.
Escape the '*' with a '\'.
The texinfo document generator will leave the '\' in the
output, which is not ideal, but that generator is going to
go away in a subsequent commit.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/machine.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 51ffa96be98..a83a7b56b14 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -12,7 +12,7 @@
#
# The comprehensive enumeration of QEMU system emulation ("softmmu")
# targets. Run "./configure --help" in the project root directory, and
-# look for the *-softmmu targets near the "--target-list" option. The
+# look for the \*-softmmu targets near the "--target-list" option. The
# individual target constants are not documented here, for the time
# being.
#
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (19 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 22/29] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
` (12 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
As we accumulate lines from doc comments when parsing the JSON, the
QAPIDoc class generally strips leading and trailing whitespace using
line.strip() when it calls _append_freeform(). This is fine for
texinfo, but for rST leading whitespace is significant. We'd like to
move to having the text in doc comments be rST format rather than a
custom syntax, so move the removal of leading whitespace from the
QAPIDoc class to the texinfo-specific processing code in
texi_format() in qapi/doc.py.
(Trailing whitespace will always be stripped by the rstrip() in
Section::append regardless.)
In a followup commit we will make the whitespace in the lines of doc
comment sections more consistently follow the input source.
There is no change to the generated .texi files before and after this
commit.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
scripts/qapi/doc.py | 1 +
scripts/qapi/parser.py | 12 ++++--------
2 files changed, 5 insertions(+), 8 deletions(-)
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
index 6f1c17f71f7..96346c9b14f 100644
--- a/scripts/qapi/doc.py
+++ b/scripts/qapi/doc.py
@@ -80,6 +80,7 @@ def texi_format(doc):
inlist = ''
lastempty = False
for line in doc.split('\n'):
+ line = line.strip()
empty = line == ''
# FIXME: Doing this in a single if / elif chain is
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 342792e4103..2196ec5de1e 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -422,10 +422,10 @@ class QAPIDoc(object):
self._append_line = self._append_various_line
self._append_various_line(line)
else:
- self._append_freeform(line.strip())
+ self._append_freeform(line)
else:
# This is a free-form documentation block
- self._append_freeform(line.strip())
+ self._append_freeform(line)
def _append_args_line(self, line):
"""
@@ -458,7 +458,7 @@ class QAPIDoc(object):
self._append_various_line(line)
return
- self._append_freeform(line.strip())
+ self._append_freeform(line)
def _append_features_line(self, line):
name = line.split(' ', 1)[0]
@@ -477,7 +477,7 @@ class QAPIDoc(object):
self._append_various_line(line)
return
- self._append_freeform(line.strip())
+ self._append_freeform(line)
def _append_various_line(self, line):
"""
@@ -500,10 +500,6 @@ class QAPIDoc(object):
line = line[len(name)+1:]
self._start_section(name[:-1])
- if (not self._section.name or
- not self._section.name.startswith('Example')):
- line = line.strip()
-
self._append_freeform(line)
def _start_symbol_section(self, symbols_dict, name):
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 22/29] scripts/qapi/parser.py: improve doc comment indent handling
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (20 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 23/29] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
` (11 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Make the handling of indentation in doc comments more
sophisticated, so that when we see a section like:
Notes: some text
some more text
indented line 3
we save it for the doc-comment processing code as:
some text
some more text
indented line 3
and when we see a section with the heading on its own line:
Notes:
some text
some more text
indented text
we also accept that and save it in the same form.
The exception is that we always retain indentation as-is
for Examples sections, because these are literal text.
If we detect that the comment document text is not indented
as much as we expect it to be, we throw a parse error.
(We don't complain about over-indented sections, because
for rST this can be legitimate markup.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
scripts/qapi/parser.py | 82 +++++++++++++++++++++++++++++++++---------
1 file changed, 65 insertions(+), 17 deletions(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 2196ec5de1e..66f802641c9 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -313,18 +313,32 @@ class QAPIDoc(object):
"""
class Section(object):
- def __init__(self, name=None):
+ def __init__(self, parser, name=None, indent=0):
+ # parser, for error messages about indentation
+ self._parser = parser
# optional section name (argument/member or section name)
self.name = name
# the list of lines for this section
self.text = ''
+ # the expected indent level of the text of this section
+ self._indent = indent
def append(self, line):
+ # Strip leading spaces corresponding to the expected indent level
+ # Blank lines are always OK.
+ if line:
+ spacecount = len(line) - len(line.lstrip(" "))
+ if spacecount > self._indent:
+ spacecount = self._indent
+ if spacecount < self._indent:
+ raise QAPIParseError(self._parser, "unexpected de-indent")
+ line = line[spacecount:]
+
self.text += line.rstrip() + '\n'
class ArgSection(Section):
- def __init__(self, name):
- QAPIDoc.Section.__init__(self, name)
+ def __init__(self, parser, name, indent=0):
+ QAPIDoc.Section.__init__(self, parser, name, indent)
self.member = None
def connect(self, member):
@@ -338,7 +352,7 @@ class QAPIDoc(object):
self._parser = parser
self.info = info
self.symbol = None
- self.body = QAPIDoc.Section()
+ self.body = QAPIDoc.Section(parser)
# dict mapping parameter name to ArgSection
self.args = OrderedDict()
self.features = OrderedDict()
@@ -443,7 +457,18 @@ class QAPIDoc(object):
if name.startswith('@') and name.endswith(':'):
line = line[len(name)+1:]
- self._start_args_section(name[1:-1])
+ if not line or line.isspace():
+ # Line was just the "@arg:" header; following lines
+ # are not indented
+ indent = 0
+ line = ''
+ else:
+ # Line is "@arg: first line of description"; following
+ # lines should be indented by len(name) + 1, and we
+ # pad out this first line so it is handled the same way
+ indent = len(name) + 1
+ line = ' ' * indent + line
+ self._start_args_section(name[1:-1], indent)
elif self._is_section_tag(name):
self._append_line = self._append_various_line
self._append_various_line(line)
@@ -465,7 +490,17 @@ class QAPIDoc(object):
if name.startswith('@') and name.endswith(':'):
line = line[len(name)+1:]
- self._start_features_section(name[1:-1])
+ if not line or line.isspace():
+ # Line is just the "@name:" header, no ident for following lines
+ indent = 0
+ line = ''
+ else:
+ # Line is "@arg: first line of description"; following
+ # lines should be indented by len(name) + 3, and we
+ # pad out this first line so it is handled the same way
+ indent = len(name) + 1
+ line = ' ' * indent + line
+ self._start_features_section(name[1:-1], indent)
elif self._is_section_tag(name):
self._append_line = self._append_various_line
self._append_various_line(line)
@@ -498,11 +533,23 @@ class QAPIDoc(object):
% (name, self.sections[0].name))
elif self._is_section_tag(name):
line = line[len(name)+1:]
- self._start_section(name[:-1])
+ if not line or line.isspace():
+ # Line is just "SectionName:", no indent for following lines
+ indent = 0
+ line = ''
+ elif name.startswith("Example"):
+ # The "Examples" section is literal-text, so preserve
+ # all the indentation as-is
+ indent = 0
+ else:
+ # Line is "SectionName: some text", indent required
+ indent = len(name) + 1
+ line = ' ' * indent + line
+ self._start_section(name[:-1], indent)
self._append_freeform(line)
- def _start_symbol_section(self, symbols_dict, name):
+ def _start_symbol_section(self, symbols_dict, name, indent):
# FIXME invalid names other than the empty string aren't flagged
if not name:
raise QAPIParseError(self._parser, "invalid parameter name")
@@ -511,21 +558,21 @@ class QAPIDoc(object):
"'%s' parameter name duplicated" % name)
assert not self.sections
self._end_section()
- self._section = QAPIDoc.ArgSection(name)
+ self._section = QAPIDoc.ArgSection(self._parser, name, indent)
symbols_dict[name] = self._section
- def _start_args_section(self, name):
- self._start_symbol_section(self.args, name)
+ def _start_args_section(self, name, indent):
+ self._start_symbol_section(self.args, name, indent)
- def _start_features_section(self, name):
- self._start_symbol_section(self.features, name)
+ def _start_features_section(self, name, indent):
+ self._start_symbol_section(self.features, name, indent)
- def _start_section(self, name=None):
+ def _start_section(self, name=None, indent=0):
if name in ('Returns', 'Since') and self.has_section(name):
raise QAPIParseError(self._parser,
"duplicated '%s' section" % name)
self._end_section()
- self._section = QAPIDoc.Section(name)
+ self._section = QAPIDoc.Section(self._parser, name, indent)
self.sections.append(self._section)
def _end_section(self):
@@ -548,7 +595,7 @@ class QAPIDoc(object):
def connect_member(self, member):
if member.name not in self.args:
# Undocumented TODO outlaw
- self.args[member.name] = QAPIDoc.ArgSection(member.name)
+ self.args[member.name] = QAPIDoc.ArgSection(self._parser, member.name)
self.args[member.name].connect(member)
def connect_feature(self, feature):
@@ -556,7 +603,8 @@ class QAPIDoc(object):
raise QAPISemError(feature.info,
"feature '%s' lacks documentation"
% feature.name)
- self.features[feature.name] = QAPIDoc.ArgSection(feature.name)
+ self.features[feature.name] = QAPIDoc.ArgSection(self._parser,
+ feature.name)
self.features[feature.name].connect(feature)
def check_expr(self, expr):
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 23/29] docs/sphinx: Add new qapi-doc Sphinx extension
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (21 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 22/29] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 24/29] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
` (10 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Some of our documentation is auto-generated from documentation
comments in the JSON schema.
For Sphinx, rather than creating a file to include, the most natural
way to handle this is to have a small custom Sphinx extension which
processes the JSON file and inserts documentation into the rST
file being processed.
This is the same approach that kerneldoc and hxtool use.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
MAINTAINERS | 1 +
docs/conf.py | 6 +-
docs/sphinx/qapidoc.py | 504 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 510 insertions(+), 1 deletion(-)
create mode 100644 docs/sphinx/qapidoc.py
diff --git a/MAINTAINERS b/MAINTAINERS
index e72b5e5f696..e32eaf89318 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2786,3 +2786,4 @@ M: Peter Maydell <peter.maydell@linaro.org>
S: Maintained
F: docs/conf.py
F: docs/*/conf.py
+F: docs/sphinx/
diff --git a/docs/conf.py b/docs/conf.py
index 7588bf192ee..1ada0b8f427 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -51,7 +51,10 @@ except NameError:
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use an absolute path starting from qemu_docdir.
#
+# Our extensions are in docs/sphinx; the qapidoc extension requires
+# the QAPI modules from scripts/.
sys.path.insert(0, os.path.join(qemu_docdir, "sphinx"))
+sys.path.insert(0, os.path.join(qemu_docdir, "../scripts"))
# -- General configuration ------------------------------------------------
@@ -64,7 +67,7 @@ needs_sphinx = '1.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['kerneldoc', 'qmp_lexer', 'hxtool']
+extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'qapidoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -232,3 +235,4 @@ texinfo_documents = [
kerneldoc_bin = os.path.join(qemu_docdir, '../scripts/kernel-doc')
kerneldoc_srctree = os.path.join(qemu_docdir, '..')
hxtool_srctree = os.path.join(qemu_docdir, '..')
+qapidoc_srctree = os.path.join(qemu_docdir, '..')
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
new file mode 100644
index 00000000000..d0dd6e93d4c
--- /dev/null
+++ b/docs/sphinx/qapidoc.py
@@ -0,0 +1,504 @@
+# coding=utf-8
+#
+# QEMU qapidoc QAPI file parsing extension
+#
+# Copyright (c) 2020 Linaro
+#
+# This work is licensed under the terms of the GNU GPLv2 or later.
+# See the COPYING file in the top-level directory.
+"""qapidoc is a Sphinx extension that implements the qapi-doc directive"""
+
+# The purpose of this extension is to read the documentation comments
+# in QAPI JSON schema files, and insert them all into the current document.
+# The conf.py file must set the qapidoc_srctree config value to
+# the root of the QEMU source tree.
+# Each qapi-doc:: directive takes one argument which is the
+# path of the .json file to process, relative to the source tree.
+
+import os
+import re
+
+from docutils import nodes
+from docutils.statemachine import ViewList
+from docutils.parsers.rst import directives, Directive
+from sphinx.errors import ExtensionError
+from sphinx.util.nodes import nested_parse_with_titles
+import sphinx
+from qapi.gen import QAPISchemaVisitor
+from qapi.schema import QAPIError, QAPISchema
+
+# Sphinx up to 1.6 uses AutodocReporter; 1.7 and later
+# use switch_source_input. Check borrowed from kerneldoc.py.
+Use_SSI = sphinx.__version__[:3] >= '1.7'
+if Use_SSI:
+ from sphinx.util.docutils import switch_source_input
+else:
+ from sphinx.ext.autodoc import AutodocReporter
+
+
+__version__ = '1.0'
+
+# Function borrowed from pydash, which is under the MIT license
+def intersperse(iterable, separator):
+ """Like join, but for arbitrary iterables, notably arrays"""
+ iterable = iter(iterable)
+ yield next(iterable)
+ for item in iterable:
+ yield separator
+ yield item
+
+class QAPISchemaGenRSTVisitor(QAPISchemaVisitor):
+ """A QAPI schema visitor which generates docutils/Sphinx nodes
+
+ This class builds up a tree of docutils/Sphinx nodes corresponding
+ to documentation for the various QAPI objects. To use it, first create
+ a QAPISchemaGenRSTVisitor object, and call its visit_begin() method.
+ Then you can call one of the two methods 'freeform' (to add documentation
+ for a freeform documentation chunk) or 'symbol' (to add documentation
+ for a QAPI symbol). These will cause the visitor to build up the
+ tree of document nodes. Once you've added all the documentation
+ via 'freeform' and 'symbol' method calls, you can call 'get_document_nodes'
+ to get the final list of document nodes (in a form suitable for returning
+ from a Sphinx directive's 'run' method).
+ """
+ def __init__(self, sphinx_directive):
+ self._cur_doc = None
+ self._sphinx_directive = sphinx_directive
+ self._top_node = nodes.section()
+ self._active_headings = [self._top_node]
+
+ def _serror(self, msg):
+ """Raise an exception giving a user-friendly syntax error message"""
+ file = self._cur_doc.info.fname
+ line = self._cur_doc.info.line
+ raise ExtensionError('%s line %d: syntax error: %s' % (file, line, msg))
+
+ def _make_dlitem(self, term, defn):
+ """Return a dlitem node with the specified term and definition.
+
+ term should be a list of Text and literal nodes.
+ defn should be one of:
+ - a string, which will be handed to _parse_text_into_node
+ - a list of Text and literal nodes, which will be put into
+ a paragraph node
+ """
+ dlitem = nodes.definition_list_item()
+ dlterm = nodes.term('', '', *term)
+ dlitem += dlterm
+ if defn:
+ dldef = nodes.definition()
+ if isinstance(defn, list):
+ dldef += nodes.paragraph('', '', *defn)
+ else:
+ self._parse_text_into_node(defn, dldef)
+ dlitem += dldef
+ return dlitem
+
+ def _make_section(self, title):
+ """Return a section node with optional title"""
+ section = nodes.section(ids=[self._sphinx_directive.new_serialno()])
+ if title:
+ section += nodes.title(title, title)
+ return section
+
+ def _nodes_for_ifcond(self, ifcond, with_if=True):
+ """Return list of Text, literal nodes for the ifcond
+
+ Return a list which gives text like ' (If: cond1, cond2, cond3)', where
+ the conditions are in literal-text and the commas are not.
+ If with_if is False, we don't return the "(If: " and ")".
+ """
+ condlist = intersperse([nodes.literal('', c) for c in ifcond],
+ nodes.Text(', '))
+ if not with_if:
+ return condlist
+
+ nodelist = [nodes.Text(' ('), nodes.strong('', 'If: ')]
+ nodelist.extend(condlist)
+ nodelist.append(nodes.Text(')'))
+ return nodelist
+
+ def _nodes_for_one_member(self, member):
+ """Return list of Text, literal nodes for this member
+
+ Return a list of doctree nodes which give text like
+ 'name: type (optional) (If: ...)' suitable for use as the
+ 'term' part of a definition list item.
+ """
+ term = [nodes.literal('', member.name)]
+ if member.type.doc_type():
+ term.append(nodes.Text(': '))
+ term.append(nodes.literal('', member.type.doc_type()))
+ if member.optional:
+ term.append(nodes.Text(' (optional)'))
+ if member.ifcond:
+ term.extend(self._nodes_for_ifcond(member.ifcond))
+ return term
+
+ def _nodes_for_variant_when(self, variants, variant):
+ """Return list of Text, literal nodes for variant 'when' clause
+
+ Return a list of doctree nodes which give text like
+ 'when tagname is variant (If: ...)' suitable for use in
+ the 'variants' part of a definition list.
+ """
+ term = [nodes.Text(' when '),
+ nodes.literal('', variants.tag_member.name),
+ nodes.Text(' is '),
+ nodes.literal('', '"%s"' % variant.name)]
+ if variant.ifcond:
+ term.extend(self._nodes_for_ifcond(variant.ifcond))
+ return term
+
+ def _nodes_for_members(self, doc, what, base=None, variants=None):
+ """Return doctree nodes for the table of members"""
+ dlnode = nodes.definition_list()
+ for section in doc.args.values():
+ term = self._nodes_for_one_member(section.member)
+ # TODO drop fallbacks when undocumented members are outlawed
+ if section.text:
+ defn = section.text
+ elif (variants and variants.tag_member == section.member
+ and not section.member.type.doc_type()):
+ values = section.member.type.member_names()
+ defn = [nodes.Text('One of ')]
+ defn.extend(intersperse([nodes.literal('', v) for v in values],
+ nodes.Text(', ')))
+ else:
+ defn = [nodes.Text('Not documented')]
+
+ dlnode += self._make_dlitem(term, defn)
+
+ if base:
+ dlnode += self._make_dlitem([nodes.Text('The members of '),
+ nodes.literal('', base.doc_type())],
+ None)
+
+ if variants:
+ for v in variants.variants:
+ if v.type.is_implicit():
+ assert not v.type.base and not v.type.variants
+ for m in v.type.local_members:
+ term = self._nodes_for_one_member(m)
+ term.extend(self._nodes_for_variant_when(variants, v))
+ dlnode += self._make_dlitem(term, None)
+ else:
+ term = [nodes.Text('The members of '),
+ nodes.literal('', v.type.doc_type())]
+ term.extend(self._nodes_for_variant_when(variants, v))
+ dlnode += self._make_dlitem(term, None)
+
+ if not dlnode.children:
+ return None
+
+ section = self._make_section(what)
+ section += dlnode
+ return section
+
+ def _nodes_for_enum_values(self, doc, what):
+ """Return doctree nodes for the table of enum values"""
+ seen_item = False
+ dlnode = nodes.definition_list()
+ for section in doc.args.values():
+ termtext = [nodes.literal('', section.member.name)]
+ if section.member.ifcond:
+ termtext.extend(self._nodes_for_ifcond(section.member.ifcond))
+ # TODO drop fallbacks when undocumented members are outlawed
+ if section.text:
+ defn = section.text
+ else:
+ defn = [nodes.Text('Not documented')]
+
+ dlnode += self._make_dlitem(termtext, defn)
+ seen_item = True
+
+ if not seen_item:
+ return None
+
+ section = self._make_section(what)
+ section += dlnode
+ return section
+
+ def _nodes_for_arguments(self, doc, boxed_arg_type):
+ """Return doctree nodes for the arguments section"""
+ if boxed_arg_type:
+ assert not doc.args
+ section = self._make_section('Arguments')
+ dlnode = nodes.definition_list()
+ dlnode += self._make_dlitem(
+ [nodes.Text('The members of '),
+ nodes.literal('', boxed_arg_type.name)],
+ None)
+ section += dlnode
+ return section
+
+ return self._nodes_for_members(doc, 'Arguments')
+
+ def _nodes_for_features(self, doc):
+ """Return doctree nodes for the table of features"""
+ seen_item = False
+ dlnode = nodes.definition_list()
+ for section in doc.features.values():
+ dlnode += self._make_dlitem([nodes.literal('', section.name)],
+ section.text)
+ seen_item = True
+
+ if not seen_item:
+ return None
+
+ section = self._make_section('Features')
+ section += dlnode
+ return section
+
+ def _nodes_for_example(self, exampletext):
+ """Return doctree nodes for a code example snippet"""
+ return nodes.literal_block(exampletext, exampletext)
+
+ def _nodes_for_sections(self, doc, ifcond):
+ """Return doctree nodes for additional sections following arguments"""
+ nodelist = []
+ for section in doc.sections:
+ snode = self._make_section(section.name)
+ if section.name and section.name.startswith('Example'):
+ snode += self._nodes_for_example(section.text)
+ else:
+ self._parse_text_into_node(section.text, snode)
+ nodelist.append(snode)
+ if ifcond:
+ snode = self._make_section('If')
+ snode += self._nodes_for_ifcond(ifcond, with_if=False)
+ nodelist.append(snode)
+ if not nodelist:
+ return None
+ return nodelist
+
+ def _add_doc(self, typ, sections):
+ """Add documentation for a command/object/enum...
+
+ We assume we're documenting the thing defined in self._cur_doc.
+ typ is the type of thing being added ("Command", "Object", etc)
+
+ sections is a list of nodes for sections to add to the definition.
+ """
+
+ doc = self._cur_doc
+ snode = nodes.section(ids=[self._sphinx_directive.new_serialno()])
+ snode += nodes.title('', '', *[nodes.literal(doc.symbol, doc.symbol),
+ nodes.Text(' (' + typ + ')')])
+ self._parse_text_into_node(doc.body.text, snode)
+ for s in sections:
+ if s is not None:
+ snode += s
+ self._add_node_to_current_heading(snode)
+
+ def visit_enum_type(self, name, info, ifcond, members, prefix):
+ doc = self._cur_doc
+ self._add_doc('Enum',
+ [self._nodes_for_enum_values(doc, 'Values'),
+ self._nodes_for_features(doc),
+ self._nodes_for_sections(doc, ifcond)])
+
+ def visit_object_type(self, name, info, ifcond, base, members, variants,
+ features):
+ doc = self._cur_doc
+ if base and base.is_implicit():
+ base = None
+ self._add_doc('Object',
+ [self._nodes_for_members(doc, 'Members', base, variants),
+ self._nodes_for_features(doc),
+ self._nodes_for_sections(doc, ifcond)])
+
+ def visit_alternate_type(self, name, info, ifcond, variants):
+ doc = self._cur_doc
+ self._add_doc('Alternate',
+ [self._nodes_for_members(doc, 'Members'),
+ self._nodes_for_features(doc),
+ self._nodes_for_sections(doc, ifcond)])
+
+ def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
+ success_response, boxed, allow_oob, allow_preconfig,
+ features):
+ doc = self._cur_doc
+ self._add_doc('Command',
+ [self._nodes_for_arguments(doc,
+ arg_type if boxed else None),
+ self._nodes_for_features(doc),
+ self._nodes_for_sections(doc, ifcond)])
+
+ def visit_event(self, name, info, ifcond, arg_type, boxed):
+ doc = self._cur_doc
+ self._add_doc('Event',
+ [self._nodes_for_arguments(doc,
+ arg_type if boxed else None),
+ self._nodes_for_features(doc),
+ self._nodes_for_sections(doc, ifcond)])
+
+ def symbol(self, doc, entity):
+ """Add documentation for one symbol to the document tree
+
+ This is the main entry point which causes us to add documentation
+ nodes for a symbol (which could be a 'command', 'object', 'event',
+ etc). We do this by calling 'visit' on the schema entity, which
+ will then call back into one of our visit_* methods, depending
+ on what kind of thing this symbol is.
+ """
+ self._cur_doc = doc
+ entity.visit(self)
+ self._cur_doc = None
+
+ def _start_new_heading(self, heading, level):
+ """Start a new heading at the specified heading level
+
+ Create a new section whose title is 'heading' and which is placed
+ in the docutils node tree as a child of the most recent level-1
+ heading. Subsequent document sections (commands, freeform doc chunks,
+ etc) will be placed as children of this new heading section.
+ """
+ if len(self._active_headings) < level:
+ self._serror('Level %d subheading found outside a level %d heading'
+ % (level, level - 1))
+ snode = self._make_section(heading)
+ self._active_headings[level - 1] += snode
+ self._active_headings = self._active_headings[:level]
+ self._active_headings.append(snode)
+
+ def _add_node_to_current_heading(self, node):
+ """Add the node to whatever the current active heading is"""
+ self._active_headings[-1] += node
+
+ def freeform(self, doc):
+ """Add a piece of 'freeform' documentation to the document tree
+
+ A 'freeform' document chunk doesn't relate to any particular
+ symbol (for instance, it could be an introduction).
+
+ As a special case, if the freeform document is a single line
+ of the form '= Heading text' it is treated as a section or subsection
+ heading, with the heading level indicated by the number of '=' signs.
+ """
+
+ # QAPIDoc documentation says free-form documentation blocks
+ # must have only a body section, nothing else.
+ assert not doc.sections
+ assert not doc.args
+ assert not doc.features
+ self._cur_doc = doc
+
+ if re.match(r'=+ ', doc.body.text):
+ # Section or subsection heading: must be the only thing in the block
+ (heading, _, rest) = doc.body.text.partition('\n')
+ if rest != '':
+ raise ExtensionError('%s line %s: section or subsection heading'
+ ' must be in its own doc comment block'
+ % (doc.info.fname, doc.info.line))
+ (leader, _, heading) = heading.partition(' ')
+ self._start_new_heading(heading, len(leader))
+ return
+
+ node = self._make_section(None)
+ self._parse_text_into_node(doc.body.text, node)
+ self._add_node_to_current_heading(node)
+ self._cur_doc = None
+
+ def _parse_text_into_node(self, doctext, node):
+ """Parse a chunk of QAPI-doc-format text into the node
+
+ The doc comment can contain most inline rST markup, including
+ bulleted and enumerated lists.
+ As an extra permitted piece of markup, @var will be turned
+ into ``var``.
+ """
+
+ # Handle the "@var means ``var`` case
+ doctext = re.sub(r'@([\w-]+)', r'``\1``', doctext)
+
+ rstlist = ViewList()
+ for line in doctext.splitlines():
+ # The reported line number will always be that of the start line
+ # of the doc comment, rather than the actual location of the error.
+ # Being more precise would require overhaul of the QAPIDoc class
+ # to track lines more exactly within all the sub-parts of the doc
+ # comment, as well as counting lines here.
+ rstlist.append(line, self._cur_doc.info.fname,
+ self._cur_doc.info.line)
+ self._sphinx_directive.do_parse(rstlist, node)
+
+ def get_document_nodes(self):
+ """Return the list of docutils nodes which make up the document"""
+ return self._top_node.children
+
+class QAPIDocDirective(Directive):
+ """Extract documentation from the specified QAPI .json file"""
+ required_argument = 1
+ optional_arguments = 1
+ option_spec = {
+ 'qapifile': directives.unchanged_required
+ }
+ has_content = False
+
+ def new_serialno(self):
+ """Return a unique new ID string suitable for use as a node's ID"""
+ env = self.state.document.settings.env
+ return 'qapidoc-%d' % env.new_serialno('qapidoc')
+
+ def run(self):
+ env = self.state.document.settings.env
+ qapifile = env.config.qapidoc_srctree + '/' + self.arguments[0]
+
+ # Tell sphinx of the dependency
+ env.note_dependency(os.path.abspath(qapifile))
+
+ try:
+ schema = QAPISchema(qapifile)
+ except QAPIError as err:
+ # Launder QAPI parse errors into Sphinx extension errors
+ # so they are displayed nicely to the user
+ raise ExtensionError(str(err))
+
+ vis = QAPISchemaGenRSTVisitor(self)
+ vis.visit_begin(schema)
+ for doc in schema.docs:
+ if doc.symbol:
+ vis.symbol(doc, schema.lookup_entity(doc.symbol))
+ else:
+ vis.freeform(doc)
+
+ return vis.get_document_nodes()
+
+ def do_parse(self, rstlist, node):
+ """Parse rST source lines and add them to the specified node
+
+ Take the list of rST source lines rstlist, parse them as
+ rST, and add the resulting docutils nodes as children of node.
+ The nodes are parsed in a way that allows them to include
+ subheadings (titles) without confusing the rendering of
+ anything else.
+ """
+ # This is from kerneldoc.py -- it works around an API change in
+ # Sphinx between 1.6 and 1.7. Unlike kerneldoc.py, we use
+ # sphinx.util.nodes.nested_parse_with_titles() rather than the
+ # plain self.state.nested_parse(), and so we can drop the saving
+ # of title_styles and section_level that kerneldoc.py does,
+ # because nested_parse_with_titles() does that for us.
+ if Use_SSI:
+ with switch_source_input(self.state, rstlist):
+ nested_parse_with_titles(self.state, rstlist, node)
+ else:
+ save = self.state.memo.reporter
+ self.state.memo.reporter = AutodocReporter(rstlist,
+ self.state.memo.reporter)
+ try:
+ nested_parse_with_titles(self.state, rstlist, node)
+ finally:
+ self.state.memo.reporter = save
+
+def setup(app):
+ """ Register qapi-doc directive with Sphinx"""
+ app.add_config_value('qapidoc_srctree', None, 'env')
+ app.add_directive('qapi-doc', QAPIDocDirective)
+
+ return dict(
+ version=__version__,
+ parallel_read_safe=True,
+ parallel_write_safe=True
+ )
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 24/29] docs/interop: Convert qemu-ga-ref to rST
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (22 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 23/29] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 25/29] docs/interop: Convert qemu-qmp-ref " Peter Maydell
` (9 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Convert qemu-ga-ref to rST format. This includes dropping
the plain-text, pdf and info format outputs for this document;
as with all our other Sphinx-based documentation, we provide
HTML and manpage only.
The qemu-ga-ref.rst is somewhat more stripped down than
the .texi was, because we do not (currently) attempt to
generate indexes for the commands, events and data types
being documented.
As the GA ref is now part of the Sphinx 'interop' manual,
we can delete the direct link from index.html.in.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 42 ++++++++----------
MAINTAINERS | 2 +-
docs/index.html.in | 1 -
docs/interop/conf.py | 2 +
docs/interop/index.rst | 1 +
docs/interop/qemu-ga-ref.rst | 4 ++
docs/interop/qemu-ga-ref.texi | 80 -----------------------------------
7 files changed, 25 insertions(+), 107 deletions(-)
create mode 100644 docs/interop/qemu-ga-ref.rst
delete mode 100644 docs/interop/qemu-ga-ref.texi
diff --git a/Makefile b/Makefile
index 274a24f7aa4..790e5b2c817 100644
--- a/Makefile
+++ b/Makefile
@@ -350,7 +350,7 @@ DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-nbd.8
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8
DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7
-DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7
+DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7
DOCS+=docs/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
ifdef CONFIG_VIRTFS
@@ -759,11 +759,11 @@ distclean: clean
rm -f config.log
rm -f linux-headers/asm
rm -f docs/version.texi
- rm -f docs/interop/qemu-ga-qapi.texi docs/interop/qemu-qmp-qapi.texi
- rm -f docs/interop/qemu-qmp-ref.7 docs/interop/qemu-ga-ref.7
- rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
- rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
- rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html
+ rm -f docs/interop/qemu-qmp-qapi.texi
+ rm -f docs/interop/qemu-qmp-ref.7
+ rm -f docs/interop/qemu-qmp-ref.txt
+ rm -f docs/interop/qemu-qmp-ref.pdf
+ rm -f docs/interop/qemu-qmp-ref.html
rm -f docs/qemu-cpu-models.7
rm -rf .doctrees
$(call clean-manual,devel)
@@ -817,7 +817,7 @@ endif
# and also any sphinx-built manpages.
define install-manual =
for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/$$d"; done
-for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-*-ref.*' ')' ); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
+for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-qmp-ref.*' ')' ); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
endef
# Note that we deliberately do not install the "devel" manual: it is
@@ -852,9 +852,7 @@ ifdef CONFIG_TRACE_SYSTEMTAP
endif
ifneq (,$(findstring qemu-ga,$(TOOLS)))
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
- $(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
endif
endif
ifdef CONFIG_VIRTFS
@@ -1041,7 +1039,7 @@ endef
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
$(call build-manual,devel,html)
-$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx
+$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
$(call build-manual,interop,html)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
@@ -1051,8 +1049,10 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
$(call build-manual,system,html)
$(call define-manpage-rule,interop,\
- qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1 virtfs-proxy-helper.1,\
- $(SRC_PATH)/qemu-img-cmds.hx)
+ qemu-ga.8 qemu-ga-ref.7 \
+ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1 virtfs-proxy-helper.1,\
+ $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json \
+ $(qapi-py))
$(call define-manpage-rule,system,qemu-block-drivers.7)
@@ -1073,17 +1073,14 @@ qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scripts/hxt
docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi
@cp -p $< $@
-docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi
- @cp -p $< $@
-
qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
qemu.1: qemu-option-trace.texi
docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi
-html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs
-info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info
-pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
-txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
+html: qemu-doc.html docs/interop/qemu-qmp-ref.html sphinxdocs
+info: qemu-doc.info docs/interop/qemu-qmp-ref.info
+pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf
+txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt
qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-options.texi \
@@ -1092,11 +1089,6 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-monitor-info.texi \
docs/qemu-cpu-models.texi docs/security.texi
-docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \
- docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \
- docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \
- docs/interop/qemu-ga-ref.texi docs/interop/qemu-ga-qapi.texi
-
docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \
docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \
docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \
diff --git a/MAINTAINERS b/MAINTAINERS
index e32eaf89318..e99fb4b0b0e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2126,9 +2126,9 @@ M: Michael Roth <mdroth@linux.vnet.ibm.com>
S: Maintained
F: qga/
F: docs/interop/qemu-ga.rst
+F: docs/interop/qemu-ga-ref.rst
F: scripts/qemu-guest-agent/
F: tests/test-qga.c
-F: docs/interop/qemu-ga-ref.texi
T: git https://github.com/mdroth/qemu.git qga
QOM
diff --git a/docs/index.html.in b/docs/index.html.in
index 8512933d145..92a057101e6 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -9,7 +9,6 @@
<ul>
<li><a href="qemu-doc.html">User Documentation</a></li>
<li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
- <li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li><a href="system/index.html">System Emulation User's Guide</a></li>
diff --git a/docs/interop/conf.py b/docs/interop/conf.py
index b0f322207ca..21e1ac74282 100644
--- a/docs/interop/conf.py
+++ b/docs/interop/conf.py
@@ -19,6 +19,8 @@ html_theme_options['description'] = u'System Emulation Management and Interopera
man_pages = [
('qemu-ga', 'qemu-ga', u'QEMU Guest Agent',
['Michael Roth <mdroth@linux.vnet.ibm.com>'], 8),
+ ('qemu-ga-ref', 'qemu-ga-ref', u'QEMU Guest Agent Protocol Reference',
+ [], 7),
('qemu-img', 'qemu-img', u'QEMU disk image utility',
['Fabrice Bellard'], 1),
('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 3b763b1eebe..3102eef4add 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -18,6 +18,7 @@ Contents:
live-block-operations
pr-helper
qemu-ga
+ qemu-ga-ref
qemu-img
qemu-nbd
qemu-trace-stap
diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
new file mode 100644
index 00000000000..013eac0bb53
--- /dev/null
+++ b/docs/interop/qemu-ga-ref.rst
@@ -0,0 +1,4 @@
+QEMU Guest Agent Protocol Reference
+===================================
+
+.. qapi-doc:: qga/qapi-schema.json
diff --git a/docs/interop/qemu-ga-ref.texi b/docs/interop/qemu-ga-ref.texi
deleted file mode 100644
index ddb76ce1c2a..00000000000
--- a/docs/interop/qemu-ga-ref.texi
+++ /dev/null
@@ -1,80 +0,0 @@
-\input texinfo
-@setfilename qemu-ga-ref.info
-
-@include version.texi
-
-@exampleindent 0
-@paragraphindent 0
-
-@settitle QEMU Guest Agent Protocol Reference
-
-@iftex
-@center @image{docs/qemu_logo}
-@end iftex
-
-@copying
-This is the QEMU Guest Agent Protocol reference manual.
-
-Copyright @copyright{} 2016 The QEMU Project developers
-
-@quotation
-This manual is free documentation: you can redistribute it and/or
-modify it under the terms of the GNU General Public License as
-published by the Free Software Foundation, either version 2 of the
-License, or (at your option) any later version.
-
-This manual is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this manual. If not, see http://www.gnu.org/licenses/.
-@end quotation
-@end copying
-
-@dircategory QEMU
-@direntry
-* QEMU-GA-Ref: (qemu-ga-ref). QEMU Guest Agent Protocol Reference
-@end direntry
-
-@titlepage
-@title Guest Agent Protocol Reference Manual
-@subtitle QEMU version @value{VERSION}
-@page
-@vskip 0pt plus 1filll
-@insertcopying
-@end titlepage
-
-@contents
-
-@ifnottex
-@node Top
-@top QEMU Guest Agent protocol reference
-@end ifnottex
-
-@menu
-* API Reference::
-* Commands and Events Index::
-* Data Types Index::
-@end menu
-
-@node API Reference
-@chapter API Reference
-
-@c for texi2pod:
-@c man begin DESCRIPTION
-
-@include qemu-ga-qapi.texi
-
-@c man end
-
-@node Commands and Events Index
-@unnumbered Commands and Events Index
-@printindex fn
-
-@node Data Types Index
-@unnumbered Data Types Index
-@printindex tp
-
-@bye
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 25/29] docs/interop: Convert qemu-qmp-ref to rST
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (23 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 24/29] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 26/29] qapi: Use rST markup for literal blocks Peter Maydell
` (8 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Convert qemu-qmp-ref to rST format. This includes dropping
the plain-text, pdf and info format outputs for this document;
as with all our other Sphinx-based documentation, we provide
HTML and manpage only.
The qemu-qmp-ref.rst is somewhat more stripped down than
the .texi was, because we do not (currently) attempt to
generate indexes for the commands, events and data types
being documented.
Again, we drop the direct link from index.html.in now that
the QMP ref is part of the interop manual.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 37 +++++-----------
docs/index.html.in | 1 -
docs/interop/conf.py | 2 +
docs/interop/index.rst | 1 +
docs/interop/qemu-qmp-ref.rst | 4 ++
docs/interop/qemu-qmp-ref.texi | 80 ----------------------------------
6 files changed, 17 insertions(+), 108 deletions(-)
create mode 100644 docs/interop/qemu-qmp-ref.rst
delete mode 100644 docs/interop/qemu-qmp-ref.texi
diff --git a/Makefile b/Makefile
index 790e5b2c817..159ac78dd24 100644
--- a/Makefile
+++ b/Makefile
@@ -126,7 +126,6 @@ GENERATED_QAPI_FILES += qapi/qapi-events.h qapi/qapi-events.c
GENERATED_QAPI_FILES += $(QAPI_MODULES:%=qapi/qapi-events-%.h)
GENERATED_QAPI_FILES += $(QAPI_MODULES:%=qapi/qapi-events-%.c)
GENERATED_QAPI_FILES += qapi/qapi-introspect.c qapi/qapi-introspect.h
-GENERATED_QAPI_FILES += qapi/qapi-doc.texi
generated-files-y += $(GENERATED_QAPI_FILES)
@@ -349,8 +348,8 @@ DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-img.1
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-nbd.8
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8
DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
-DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7
+DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7
DOCS+=docs/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
ifdef CONFIG_VIRTFS
@@ -612,8 +611,7 @@ $(SRC_PATH)/scripts/qapi-gen.py
qga/qapi-generated/qga-qapi-types.c qga/qapi-generated/qga-qapi-types.h \
qga/qapi-generated/qga-qapi-visit.c qga/qapi-generated/qga-qapi-visit.h \
qga/qapi-generated/qga-qapi-commands.h qga/qapi-generated/qga-qapi-commands.c \
-qga/qapi-generated/qga-qapi-init-commands.h qga/qapi-generated/qga-qapi-init-commands.c \
-qga/qapi-generated/qga-qapi-doc.texi: \
+qga/qapi-generated/qga-qapi-init-commands.h qga/qapi-generated/qga-qapi-init-commands.c: \
qga/qapi-generated/qapi-gen-timestamp ;
qga/qapi-generated/qapi-gen-timestamp: $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \
@@ -759,11 +757,6 @@ distclean: clean
rm -f config.log
rm -f linux-headers/asm
rm -f docs/version.texi
- rm -f docs/interop/qemu-qmp-qapi.texi
- rm -f docs/interop/qemu-qmp-ref.7
- rm -f docs/interop/qemu-qmp-ref.txt
- rm -f docs/interop/qemu-qmp-ref.pdf
- rm -f docs/interop/qemu-qmp-ref.html
rm -f docs/qemu-cpu-models.7
rm -rf .doctrees
$(call clean-manual,devel)
@@ -817,7 +810,7 @@ endif
# and also any sphinx-built manpages.
define install-manual =
for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/$$d"; done
-for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-qmp-ref.*' ')' ); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
+for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' -name '*.[0-9]'); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
endef
# Note that we deliberately do not install the "devel" manual: it is
@@ -833,13 +826,11 @@ install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
ifdef CONFIG_POSIX
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7"
- $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7"
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7"
$(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
ifeq ($(CONFIG_TOOLS),y)
@@ -1039,7 +1030,7 @@ endef
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
$(call build-manual,devel,html)
-$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-py)
+$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-modules) $(qapi-py)
$(call build-manual,interop,html)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
@@ -1052,7 +1043,7 @@ $(call define-manpage-rule,interop,\
qemu-ga.8 qemu-ga-ref.7 \
qemu-img.1 qemu-nbd.8 qemu-trace-stap.1 virtfs-proxy-helper.1,\
$(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json \
- $(qapi-py))
+ $(qapi-modules) $(qapi-py))
$(call define-manpage-rule,system,qemu-block-drivers.7)
@@ -1070,17 +1061,14 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/scripts/hxtool
qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scripts/hxtool
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")
-docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi
- @cp -p $< $@
-
qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
qemu.1: qemu-option-trace.texi
docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi
-html: qemu-doc.html docs/interop/qemu-qmp-ref.html sphinxdocs
-info: qemu-doc.info docs/interop/qemu-qmp-ref.info
-pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf
-txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt
+html: qemu-doc.html sphinxdocs
+info: qemu-doc.info
+pdf: qemu-doc.pdf
+txt: qemu-doc.txt
qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-options.texi \
@@ -1089,11 +1077,6 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
qemu-monitor-info.texi \
docs/qemu-cpu-models.texi docs/security.texi
-docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \
- docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \
- docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \
- docs/interop/qemu-qmp-ref.texi docs/interop/qemu-qmp-qapi.texi
-
$(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl
# Reports/Analysis
diff --git a/docs/index.html.in b/docs/index.html.in
index 92a057101e6..ba7cd611d26 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -8,7 +8,6 @@
<h1>QEMU @@VERSION@@ Documentation</h1>
<ul>
<li><a href="qemu-doc.html">User Documentation</a></li>
- <li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li><a href="system/index.html">System Emulation User's Guide</a></li>
diff --git a/docs/interop/conf.py b/docs/interop/conf.py
index 21e1ac74282..55bbae6053a 100644
--- a/docs/interop/conf.py
+++ b/docs/interop/conf.py
@@ -25,6 +25,8 @@ man_pages = [
['Fabrice Bellard'], 1),
('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
['Anthony Liguori <anthony@codemonkey.ws>'], 8),
+ ('qemu-qmp-ref', 'qemu-qmp-ref', u'QEMU QMP Reference Manual',
+ [], 7),
('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool',
[], 1),
('virtfs-proxy-helper', 'virtfs-proxy-helper',
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 3102eef4add..0997c1ac4ba 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -21,6 +21,7 @@ Contents:
qemu-ga-ref
qemu-img
qemu-nbd
+ qemu-qmp-ref
qemu-trace-stap
vhost-user
vhost-user-gpu
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
new file mode 100644
index 00000000000..e640903abaf
--- /dev/null
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -0,0 +1,4 @@
+QEMU QMP Reference Manual
+=========================
+
+.. qapi-doc:: qapi/qapi-schema.json
diff --git a/docs/interop/qemu-qmp-ref.texi b/docs/interop/qemu-qmp-ref.texi
deleted file mode 100644
index bb25758bd02..00000000000
--- a/docs/interop/qemu-qmp-ref.texi
+++ /dev/null
@@ -1,80 +0,0 @@
-\input texinfo
-@setfilename qemu-qmp-ref.info
-
-@include version.texi
-
-@exampleindent 0
-@paragraphindent 0
-
-@settitle QEMU QMP Reference Manual
-
-@iftex
-@center @image{docs/qemu_logo}
-@end iftex
-
-@copying
-This is the QEMU QMP reference manual.
-
-Copyright @copyright{} 2016 The QEMU Project developers
-
-@quotation
-This manual is free documentation: you can redistribute it and/or
-modify it under the terms of the GNU General Public License as
-published by the Free Software Foundation, either version 2 of the
-License, or (at your option) any later version.
-
-This manual is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this manual. If not, see http://www.gnu.org/licenses/.
-@end quotation
-@end copying
-
-@dircategory QEMU
-@direntry
-* QEMU-QMP-Ref: (qemu-qmp-ref). QEMU QMP Reference Manual
-@end direntry
-
-@titlepage
-@title QMP Reference Manual
-@subtitle QEMU version @value{VERSION}
-@page
-@vskip 0pt plus 1filll
-@insertcopying
-@end titlepage
-
-@contents
-
-@ifnottex
-@node Top
-@top QEMU QMP reference
-@end ifnottex
-
-@menu
-* API Reference::
-* Commands and Events Index::
-* Data Types Index::
-@end menu
-
-@node API Reference
-@chapter API Reference
-
-@c for texi2pod:
-@c man begin DESCRIPTION
-
-@include qemu-qmp-qapi.texi
-
-@c man end
-
-@node Commands and Events Index
-@unnumbered Commands and Events Index
-@printindex fn
-
-@node Data Types Index
-@unnumbered Data Types Index
-@printindex tp
-
-@bye
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 26/29] qapi: Use rST markup for literal blocks
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (24 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 25/29] docs/interop: Convert qemu-qmp-ref " Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 27/29] qga/qapi-schema.json: Add some headings Peter Maydell
` (7 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
There are exactly two places in our json doc comments where we
use the markup accepted by the texi doc generator where a '|' in
the first line of a doc comment means the line should be emitted
as a literal block (fixed-width font, whitespace preserved).
Since we use this syntax so rarely, instead of making the rST
generator support it, instead just convert the two uses to
rST-format literal blocks, which are indented and introduced
with '::'.
(The rST generator doesn't complain about the old style syntax,
it just emits it with the '|' and with the whitespace not
preserved, which looks odd, but means we can safely leave this
change until after we've stopped generating texinfo.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/block-core.json | 16 +++++++++-------
qapi/qapi-schema.json | 6 ++++--
2 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 092cd8f13d9..ea0371c33fb 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -550,13 +550,15 @@
# For the example above, @bins may be something like [3, 1, 5, 2],
# and corresponding histogram looks like:
#
-# | 5| *
-# | 4| *
-# | 3| * *
-# | 2| * * *
-# | 1| * * * *
-# | +------------------
-# | 10 50 100
+# ::
+#
+# 5| *
+# 4| *
+# 3| * *
+# 2| * * *
+# 1| * * * *
+# +------------------
+# 10 50 100
#
# Since: 4.0
##
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index f7ba60a5d0b..1d3fb573846 100644
--- a/qapi/qapi-schema.json
+++ b/qapi/qapi-schema.json
@@ -22,8 +22,10 @@
#
# Example:
#
-# | -> data issued by the Client
-# | <- Server data response
+# ::
+#
+# -> data issued by the Client
+# <- Server data response
#
# Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for
# detailed information on the Server command and response formats.
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 27/29] qga/qapi-schema.json: Add some headings
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (25 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 26/29] qapi: Use rST markup for literal blocks Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 28/29] scripts/qapi: Remove texinfo generation support Peter Maydell
` (6 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Add some section headings to the QGA json; this is purely so that we
have some H1 headings, as otherwise each command ends up being
visible in the interop/ manual's table of contents. In an ideal
world there might be a proper 'Introduction' section the way there is
in qapi/qapi-schema.json.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qga/qapi-schema.json | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 0e3a00ee052..0b44da359b6 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1,14 +1,18 @@
# *-*- Mode: Python -*-*
##
-#
-# General note concerning the use of guest agent interfaces:
-#
+# = General note concerning the use of guest agent interfaces
+##
+
+##
# "unsupported" is a higher-level error than the errors that individual
# commands might document. The caller should always be prepared to receive
# QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn't
# document any failure mode at all.
-#
+##
+
+##
+# = QEMU guest agent protocol commands and structs
##
{ 'pragma': { 'doc-required': true } }
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* [PATCH 28/29] scripts/qapi: Remove texinfo generation support
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (26 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 27/29] qga/qapi-schema.json: Add some headings Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 17:59 ` Peter Maydell
2020-02-06 17:30 ` [PATCH 29/29] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
` (5 subsequent siblings)
33 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
We no longer use the generated texinfo format documentation,
so delete the code that generates it, and the test case for
the generation.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 1 -
tests/Makefile.include | 15 +-
scripts/qapi-gen.py | 2 -
scripts/qapi/doc.py | 303 -----------------------------------------
scripts/qapi/gen.py | 7 -
5 files changed, 1 insertion(+), 327 deletions(-)
delete mode 100644 scripts/qapi/doc.py
diff --git a/Makefile b/Makefile
index 159ac78dd24..8213dfec013 100644
--- a/Makefile
+++ b/Makefile
@@ -595,7 +595,6 @@ qemu-keymap$(EXESUF): QEMU_CFLAGS += $(XKBCOMMON_CFLAGS)
qapi-py = $(SRC_PATH)/scripts/qapi/__init__.py \
$(SRC_PATH)/scripts/qapi/commands.py \
$(SRC_PATH)/scripts/qapi/common.py \
-$(SRC_PATH)/scripts/qapi/doc.py \
$(SRC_PATH)/scripts/qapi/error.py \
$(SRC_PATH)/scripts/qapi/events.py \
$(SRC_PATH)/scripts/qapi/expr.py \
diff --git a/tests/Makefile.include b/tests/Makefile.include
index 2f1cafed720..ee766a77091 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -32,7 +32,6 @@ export SRC_PATH
qapi-py = $(SRC_PATH)/scripts/qapi/__init__.py \
$(SRC_PATH)/scripts/qapi/commands.py \
$(SRC_PATH)/scripts/qapi/common.py \
-$(SRC_PATH)/scripts/qapi/doc.py \
$(SRC_PATH)/scripts/qapi/error.py \
$(SRC_PATH)/scripts/qapi/events.py \
$(SRC_PATH)/scripts/qapi/expr.py \
@@ -486,16 +485,8 @@ tests/test-qapi-gen-timestamp: \
$(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \
-o tests -p "test-" $<, \
"GEN","$(@:%-timestamp=%)")
- @rm -f tests/test-qapi-doc.texi
@>$@
-tests/qapi-schema/doc-good.test.texi: $(SRC_PATH)/tests/qapi-schema/doc-good.json $(qapi-py)
- $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \
- -o tests/qapi-schema -p "doc-good-" $<, \
- "GEN","$@")
- @mv tests/qapi-schema/doc-good-qapi-doc.texi $@
- @rm -f tests/qapi-schema/doc-good-qapi-*.[ch] tests/qapi-schema/doc-good-qmp-*.[ch]
-
tests/qtest/dbus-vmstate1.h tests/qtest/dbus-vmstate1.c: tests/qtest/dbus-vmstate1-gen-timestamp ;
tests/qtest/dbus-vmstate1-gen-timestamp: $(SRC_PATH)/tests/qtest/dbus-vmstate1.xml
$(call quiet-command,$(GDBUS_CODEGEN) $< \
@@ -847,10 +838,6 @@ check-tests/qapi-schema/frontend: $(addprefix $(SRC_PATH)/, $(check-qapi-schema-
PYTHONIOENCODING=utf-8 $(PYTHON) $(SRC_PATH)/tests/qapi-schema/test-qapi.py $^, \
TEST, check-qapi-schema)
-.PHONY: check-tests/qapi-schema/doc-good.texi
-check-tests/qapi-schema/doc-good.texi: tests/qapi-schema/doc-good.test.texi
- @diff -u $(SRC_PATH)/tests/qapi-schema/doc-good.texi $<
-
.PHONY: check-decodetree
check-decodetree:
$(call quiet-command, \
@@ -898,7 +885,7 @@ check-acceptance: check-venv $(TESTS_RESULTS_DIR)
# Consolidated targets
.PHONY: check-block check-qapi-schema check-qtest check-unit check check-clean
-check-qapi-schema: check-tests/qapi-schema/frontend check-tests/qapi-schema/doc-good.texi
+check-qapi-schema: check-tests/qapi-schema/frontend
check-qtest: $(patsubst %,check-qtest-%, $(QTEST_TARGETS))
ifeq ($(CONFIG_TOOLS),y)
check-block: $(patsubst %,check-%, $(check-block-y))
diff --git a/scripts/qapi-gen.py b/scripts/qapi-gen.py
index f93f3c7c233..2d39714fa36 100755
--- a/scripts/qapi-gen.py
+++ b/scripts/qapi-gen.py
@@ -11,7 +11,6 @@ import re
import sys
from qapi.commands import gen_commands
-from qapi.doc import gen_doc
from qapi.events import gen_events
from qapi.introspect import gen_introspect
from qapi.schema import QAPIError, QAPISchema
@@ -52,7 +51,6 @@ def main(argv):
gen_commands(schema, args.output_dir, args.prefix)
gen_events(schema, args.output_dir, args.prefix)
gen_introspect(schema, args.output_dir, args.prefix, args.unmask)
- gen_doc(schema, args.output_dir, args.prefix)
if __name__ == '__main__':
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
deleted file mode 100644
index 96346c9b14f..00000000000
--- a/scripts/qapi/doc.py
+++ /dev/null
@@ -1,303 +0,0 @@
-# QAPI texi generator
-#
-# This work is licensed under the terms of the GNU LGPL, version 2+.
-# See the COPYING file in the top-level directory.
-"""This script produces the documentation of a qapi schema in texinfo format"""
-
-from __future__ import print_function
-import re
-from qapi.gen import QAPIGenDoc, QAPISchemaVisitor
-
-
-MSG_FMT = """
-@deftypefn {type} {{}} {name}
-
-{body}{members}{features}{sections}
-@end deftypefn
-
-""".format
-
-TYPE_FMT = """
-@deftp {{{type}}} {name}
-
-{body}{members}{features}{sections}
-@end deftp
-
-""".format
-
-EXAMPLE_FMT = """@example
-{code}
-@end example
-""".format
-
-
-def subst_strong(doc):
- """Replaces *foo* by @strong{foo}"""
- return re.sub(r'\*([^*\n]+)\*', r'@strong{\1}', doc)
-
-
-def subst_emph(doc):
- """Replaces _foo_ by @emph{foo}"""
- return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc)
-
-
-def subst_vars(doc):
- """Replaces @var by @code{var}"""
- return re.sub(r'@([\w-]+)', r'@code{\1}', doc)
-
-
-def subst_braces(doc):
- """Replaces {} with @{ @}"""
- return doc.replace('{', '@{').replace('}', '@}')
-
-
-def texi_example(doc):
- """Format @example"""
- # TODO: Neglects to escape @ characters.
- # We should probably escape them in subst_braces(), and rename the
- # function to subst_special() or subs_texi_special(). If we do that, we
- # need to delay it until after subst_vars() in texi_format().
- doc = subst_braces(doc).strip('\n')
- return EXAMPLE_FMT(code=doc)
-
-
-def texi_format(doc):
- """
- Format documentation
-
- Lines starting with:
- - |: generates an @example
- - =: generates @section
- - ==: generates @subsection
- - 1. or 1): generates an @enumerate @item
- - */-: generates an @itemize list
- """
- ret = ''
- doc = subst_braces(doc)
- doc = subst_vars(doc)
- doc = subst_emph(doc)
- doc = subst_strong(doc)
- inlist = ''
- lastempty = False
- for line in doc.split('\n'):
- line = line.strip()
- empty = line == ''
-
- # FIXME: Doing this in a single if / elif chain is
- # problematic. For instance, a line without markup terminates
- # a list if it follows a blank line (reaches the final elif),
- # but a line with some *other* markup, such as a = title
- # doesn't.
- #
- # Make sure to update section "Documentation markup" in
- # docs/devel/qapi-code-gen.txt when fixing this.
- if line.startswith('| '):
- line = EXAMPLE_FMT(code=line[2:])
- elif line.startswith('= '):
- line = '@section ' + line[2:]
- elif line.startswith('== '):
- line = '@subsection ' + line[3:]
- elif re.match(r'^([0-9]*\.) ', line):
- if not inlist:
- ret += '@enumerate\n'
- inlist = 'enumerate'
- ret += '@item\n'
- line = line[line.find(' ')+1:]
- elif re.match(r'^[*-] ', line):
- if not inlist:
- ret += '@itemize %s\n' % {'*': '@bullet',
- '-': '@minus'}[line[0]]
- inlist = 'itemize'
- ret += '@item\n'
- line = line[2:]
- elif lastempty and inlist:
- ret += '@end %s\n\n' % inlist
- inlist = ''
-
- lastempty = empty
- ret += line + '\n'
-
- if inlist:
- ret += '@end %s\n\n' % inlist
- return ret
-
-
-def texi_body(doc):
- """Format the main documentation body"""
- return texi_format(doc.body.text)
-
-
-def texi_if(ifcond, prefix='\n', suffix='\n'):
- """Format the #if condition"""
- if not ifcond:
- return ''
- return '%s@b{If:} @code{%s}%s' % (prefix, ', '.join(ifcond), suffix)
-
-
-def texi_enum_value(value, desc, suffix):
- """Format a table of members item for an enumeration value"""
- return '@item @code{%s}\n%s%s' % (
- value.name, desc, texi_if(value.ifcond, prefix='@*'))
-
-
-def texi_member(member, desc, suffix):
- """Format a table of members item for an object type member"""
- typ = member.type.doc_type()
- membertype = ': ' + typ if typ else ''
- return '@item @code{%s%s}%s%s\n%s%s' % (
- member.name, membertype,
- ' (optional)' if member.optional else '',
- suffix, desc, texi_if(member.ifcond, prefix='@*'))
-
-
-def texi_members(doc, what, base=None, variants=None,
- member_func=texi_member):
- """Format the table of members"""
- items = ''
- for section in doc.args.values():
- # TODO Drop fallbacks when undocumented members are outlawed
- if section.text:
- desc = texi_format(section.text)
- elif (variants and variants.tag_member == section.member
- and not section.member.type.doc_type()):
- values = section.member.type.member_names()
- members_text = ', '.join(['@t{"%s"}' % v for v in values])
- desc = 'One of ' + members_text + '\n'
- else:
- desc = 'Not documented\n'
- items += member_func(section.member, desc, suffix='')
- if base:
- items += '@item The members of @code{%s}\n' % base.doc_type()
- if variants:
- for v in variants.variants:
- when = ' when @code{%s} is @t{"%s"}%s' % (
- variants.tag_member.name, v.name, texi_if(v.ifcond, " (", ")"))
- if v.type.is_implicit():
- assert not v.type.base and not v.type.variants
- for m in v.type.local_members:
- items += member_func(m, desc='', suffix=when)
- else:
- items += '@item The members of @code{%s}%s\n' % (
- v.type.doc_type(), when)
- if not items:
- return ''
- return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items)
-
-
-def texi_arguments(doc, boxed_arg_type):
- if boxed_arg_type:
- assert not doc.args
- return ('\n@b{Arguments:} the members of @code{%s}\n'
- % boxed_arg_type.name)
- return texi_members(doc, 'Arguments')
-
-
-def texi_features(doc):
- """Format the table of features"""
- items = ''
- for section in doc.features.values():
- desc = texi_format(section.text)
- items += '@item @code{%s}\n%s' % (section.name, desc)
- if not items:
- return ''
- return '\n@b{Features:}\n@table @asis\n%s@end table\n' % (items)
-
-
-def texi_sections(doc, ifcond):
- """Format additional sections following arguments"""
- body = ''
- for section in doc.sections:
- if section.name:
- # prefer @b over @strong, so txt doesn't translate it to *Foo:*
- body += '\n@b{%s:}\n' % section.name
- if section.name and section.name.startswith('Example'):
- body += texi_example(section.text)
- else:
- body += texi_format(section.text)
- body += texi_if(ifcond, suffix='')
- return body
-
-
-def texi_type(typ, doc, ifcond, members):
- return TYPE_FMT(type=typ,
- name=doc.symbol,
- body=texi_body(doc),
- members=members,
- features=texi_features(doc),
- sections=texi_sections(doc, ifcond))
-
-
-def texi_msg(typ, doc, ifcond, members):
- return MSG_FMT(type=typ,
- name=doc.symbol,
- body=texi_body(doc),
- members=members,
- features=texi_features(doc),
- sections=texi_sections(doc, ifcond))
-
-
-class QAPISchemaGenDocVisitor(QAPISchemaVisitor):
- def __init__(self, prefix):
- self._prefix = prefix
- self._gen = QAPIGenDoc(self._prefix + 'qapi-doc.texi')
- self.cur_doc = None
-
- def write(self, output_dir):
- self._gen.write(output_dir)
-
- def visit_enum_type(self, name, info, ifcond, members, prefix):
- doc = self.cur_doc
- self._gen.add(texi_type('Enum', doc, ifcond,
- texi_members(doc, 'Values',
- member_func=texi_enum_value)))
-
- def visit_object_type(self, name, info, ifcond, base, members, variants,
- features):
- doc = self.cur_doc
- if base and base.is_implicit():
- base = None
- self._gen.add(texi_type('Object', doc, ifcond,
- texi_members(doc, 'Members', base, variants)))
-
- def visit_alternate_type(self, name, info, ifcond, variants):
- doc = self.cur_doc
- self._gen.add(texi_type('Alternate', doc, ifcond,
- texi_members(doc, 'Members')))
-
- def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
- success_response, boxed, allow_oob, allow_preconfig,
- features):
- doc = self.cur_doc
- self._gen.add(texi_msg('Command', doc, ifcond,
- texi_arguments(doc,
- arg_type if boxed else None)))
-
- def visit_event(self, name, info, ifcond, arg_type, boxed):
- doc = self.cur_doc
- self._gen.add(texi_msg('Event', doc, ifcond,
- texi_arguments(doc,
- arg_type if boxed else None)))
-
- def symbol(self, doc, entity):
- if self._gen._body:
- self._gen.add('\n')
- self.cur_doc = doc
- entity.visit(self)
- self.cur_doc = None
-
- def freeform(self, doc):
- assert not doc.args
- if self._gen._body:
- self._gen.add('\n')
- self._gen.add(texi_body(doc) + texi_sections(doc, None))
-
-
-def gen_doc(schema, output_dir, prefix):
- vis = QAPISchemaGenDocVisitor(prefix)
- vis.visit_begin(schema)
- for doc in schema.docs:
- if doc.symbol:
- vis.symbol(doc, schema.lookup_entity(doc.symbol))
- else:
- vis.freeform(doc)
- vis.write(output_dir)
diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py
index 95afae0615a..7712d2d49f7 100644
--- a/scripts/qapi/gen.py
+++ b/scripts/qapi/gen.py
@@ -177,13 +177,6 @@ def ifcontext(ifcond, *args):
arg.end_if()
-class QAPIGenDoc(QAPIGen):
-
- def _top(self):
- return (QAPIGen._top(self)
- + '@c AUTOMATICALLY GENERATED, DO NOT MODIFY\n\n')
-
-
class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor):
def __init__(self, prefix, what, blurb, pydoc):
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 28/29] scripts/qapi: Remove texinfo generation support
2020-02-06 17:30 ` [PATCH 28/29] scripts/qapi: Remove texinfo generation support Peter Maydell
@ 2020-02-06 17:59 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:59 UTC (permalink / raw)
To: QEMU Developers
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
On Thu, 6 Feb 2020 at 17:31, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> We no longer use the generated texinfo format documentation,
> so delete the code that generates it, and the test case for
> the generation.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Makefile | 1 -
> tests/Makefile.include | 15 +-
> scripts/qapi-gen.py | 2 -
> scripts/qapi/doc.py | 303 -----------------------------------------
> scripts/qapi/gen.py | 7 -
> 5 files changed, 1 insertion(+), 327 deletions(-)
> delete mode 100644 scripts/qapi/doc.py
Looks like I forgot to delete the no-longer-used golden
reference tests/qapi-schema/doc-good.texi -- I'll just fold
that 'git rm' into this patch, in the unlikely event that I don't
need to respin it for some other reason.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* [PATCH 29/29] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (27 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 28/29] scripts/qapi: Remove texinfo generation support Peter Maydell
@ 2020-02-06 17:30 ` Peter Maydell
2020-02-06 18:47 ` [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (4 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 17:30 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
Update the documentation of QAPI document comment syntax to match
the new rST backend requirements. The principal changes are:
* whitespace is now significant, and multiline definitions
must have their second and subsequent lines indented to
match the first line
* general rST format markup is permitted, not just the small
set of markup the old texinfo generator handled. For most
things (notably bulleted and itemized lists) the old format
is the same as rST was.
* Specific things that might trip people up:
- instead of *bold* and _italic_ rST has **bold** and *italic*
- lists need a preceding and following blank line
- a lone literal '*' will need to be backslash-escaped to
avoid a rST syntax error
* the old leading '|' for example (literal text) blocks is
replaced by the standard rST '::' literal block.
* headings and subheadings must now be in a freeform
documentation comment of their own
* we support arbitrary levels of sub- and sub-sub-heading, not
just a main and sub-heading like the old texinfo generator
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/devel/qapi-code-gen.txt | 90 ++++++++++++++++++++++++------------
1 file changed, 61 insertions(+), 29 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 59d6973e1ec..688eb2a0237 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -795,21 +795,39 @@ See below for more on definition documentation.
Free-form documentation may be used to provide additional text and
structuring content.
+==== Headings and subheadings ====
+
+A free-form documentation comment containing a single line
+which starts with some '=' symbols and then a space defines
+a section heading:
+
+ ##
+ # = This is a top level heading
+ ##
+
+ ##
+ # This is a free-form comment which will go under the
+ # top level heading.
+ ##
+
+ ##
+ # == This is a second level heading
+ ##
+
+Section headings must always be correctly nested, so you can only
+define a third-level heading inside a second-level heading, and so
+on. The documentation generator will catch nesting mistakes and report
+a syntax error.
==== Documentation markup ====
-Comment text starting with '=' is a section title:
+Documentation comments can use most rST markup. In particular,
+a '::' literal block can be used for examples:
- # = Section title
-
-Double the '=' for a subsection title:
-
- # == Subsection title
-
-'|' denotes examples:
-
- # | Text of the example, may span
- # | multiple lines
+ # ::
+ #
+ # Text of the example, may span
+ # multiple lines
'*' starts an itemized list:
@@ -825,37 +843,35 @@ A decimal number followed by '.' starts a numbered list:
# multiple lines
# 2. Second item
-The actual number doesn't matter. You could even use '*' instead of
-'2.' for the second item.
+The actual number doesn't matter.
-Lists can't be nested. Blank lines are currently not supported within
-lists.
+Lists of either kind must be preceded and followed by a blank line.
+If a list item's text spans multiple lines, then the second and
+subsequent lines must be correctly indented to line up with the
+first character of the first line.
-Additional whitespace between the initial '#' and the comment text is
-permitted.
-
-*foo* and _foo_ are for strong and emphasis styles respectively (they
-do not work over multiple lines). @foo is used to reference a name in
-the schema.
+The usual '**strong**', '*emphasised*' and '``literal``' markup should
+be used. If you need a single literal '*' you will need to backslash-escape it.
+As an extension beyond the usual rST syntax, you can also
+use '@foo' to reference a name in the schema; this is rendered
+the same way as '``foo``'.
Example:
##
-# = Section
-# == Subsection
-#
-# Some text foo with *strong* and _emphasis_
+# Some text foo with **bol** and *emphasis*
# 1. with a list
# 2. like that
#
# And some code:
-# | $ echo foo
-# | -> do this
-# | <- get that
#
+# ::
+#
+# $ echo foo
+# -> do this
+# <- get that
##
-
==== Definition documentation ====
Definition documentation, if present, must immediately precede the
@@ -870,6 +886,12 @@ commands and events), member (for structs and unions), branch (for
alternates), or value (for enums), and finally optional tagged
sections.
+Descriptions of arguments can span multiple lines; if they
+do then the second and subsequent lines must be indented
+to line up with the first character of the first line of the
+description. The parser will report a syntax error if there
+is insufficient indentation.
+
FIXME: the parser accepts these things in almost any order.
FIXME: union branches should be described, too.
@@ -883,6 +905,16 @@ The section ends with the start of a new section.
A 'Since: x.y.z' tagged section lists the release that introduced the
definition.
+The text of a section can start on a new line, in
+which case it must not be indented at all. It can also start
+on the same line as the 'Note:', 'Returns:', etc tag. In this
+case if it spans multiple lines then second and subsequent
+lines must be indented to match the first.
+
+An 'Example' or 'Examples' section is automatically rendered
+entirely as literal fixed-width text. In other sections,
+the text is formatted, and rST markup can be used.
+
For example:
##
--
2.20.1
^ permalink raw reply related [flat|nested] 77+ messages in thread* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (28 preceding siblings ...)
2020-02-06 17:30 ` [PATCH 29/29] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
@ 2020-02-06 18:47 ` Peter Maydell
2020-02-06 19:53 ` no-reply
` (3 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-06 18:47 UTC (permalink / raw)
To: QEMU Developers
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, Stefan Hajnoczi, John Snow
On Thu, 6 Feb 2020 at 17:30, Peter Maydell <peter.maydell@linaro.org> wrote:
> This series switches all our QAPI doc comments over from
> texinfo format to rST.
Oops, this fails 'make check' because I forgot to run it (not thinking
of docs changes as being stuff that affects test) and there are
a couple of golden-master files that need updating. I have some
minor changes that I'll put in v2 which correct that:
* a new patch "tests/qapi/doc-good.json: Clean up markup"
which removes some oddities of the old markup that we don't
want to support, tightening up the tested doc comments:
* in a single list the bullet types must all match
* lists must have leading and following blank lines
* indentation is important
* the '|' example syntax is going to go away entirely,
so stop testing it
* patches "scripts/qapi: Move doc-comment whitespace stripping to doc.py"
and "scripts/qapi/parser.py: improve doc comment indent handling"
both make minor whitespace changes that require updates to the
tests/qapi-schema/doc-good.out reference
* "scripts/qapi: Remove texinfo generation support" now
removes the no-longer-used tests/qapi-schema/doc-good.texi
I won't send v2 until this has had some review, though. If you
want a git branch with the pending-for-v2 fixups it's at:
https://git.linaro.org/people/peter.maydell/qemu-arm.git sphinx-conversions
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (29 preceding siblings ...)
2020-02-06 18:47 ` [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
@ 2020-02-06 19:53 ` no-reply
2020-02-06 19:56 ` no-reply
` (2 subsequent siblings)
33 siblings, 0 replies; 77+ messages in thread
From: no-reply @ 2020-02-06 19:53 UTC (permalink / raw)
To: peter.maydell; +Cc: berrange, armbru, mdroth, qemu-devel, stefanha, jsnow
Patchew URL: https://patchew.org/QEMU/20200206173040.17337-1-peter.maydell@linaro.org/
Hi,
This series failed the docker-mingw@fedora build test. Please find the testing commands and
their output below. If you have Docker installed, you can probably reproduce it
locally.
=== TEST SCRIPT BEGIN ===
#! /bin/bash
export ARCH=x86_64
make docker-image-fedora V=1 NETWORK=1
time make docker-test-mingw@fedora J=14 NETWORK=1
=== TEST SCRIPT END ===
GEN docs/index.html
CC crypto/aes.o
No filename or title
make: *** [/tmp/qemu-test/src/rules.mak:392: docs/interop/qemu-qmp-ref.7] Error 255
make: *** Waiting for unfinished jobs....
Traceback (most recent call last):
File "./tests/docker/docker.py", line 664, in <module>
---
raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['sudo', '-n', 'docker', 'run', '--label', 'com.qemu.instance.uuid=62059c3553b64eb384aee0a720c4473b', '-u', '1003', '--security-opt', 'seccomp=unconfined', '--rm', '-e', 'TARGET_LIST=', '-e', 'EXTRA_CONFIGURE_OPTS=', '-e', 'V=', '-e', 'J=14', '-e', 'DEBUG=', '-e', 'SHOW_ENV=', '-e', 'CCACHE_DIR=/var/tmp/ccache', '-v', '/home/patchew2/.cache/qemu-docker-ccache:/var/tmp/ccache:z', '-v', '/var/tmp/patchew-tester-tmp-_3tt9kgf/src/docker-src.2020-02-06-14.51.13.6510:/var/tmp/qemu:z,ro', 'qemu:fedora', '/var/tmp/qemu/run', 'test-mingw']' returned non-zero exit status 2.
filter=--filter=label=com.qemu.instance.uuid=62059c3553b64eb384aee0a720c4473b
make[1]: *** [docker-run] Error 1
make[1]: Leaving directory `/var/tmp/patchew-tester-tmp-_3tt9kgf/src'
make: *** [docker-run-test-mingw@fedora] Error 2
real 2m2.836s
user 0m8.762s
The full log is available at
http://patchew.org/logs/20200206173040.17337-1-peter.maydell@linaro.org/testing.docker-mingw@fedora/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (30 preceding siblings ...)
2020-02-06 19:53 ` no-reply
@ 2020-02-06 19:56 ` no-reply
2020-02-07 17:00 ` Markus Armbruster
2020-02-10 0:34 ` Aleksandar Markovic
33 siblings, 0 replies; 77+ messages in thread
From: no-reply @ 2020-02-06 19:56 UTC (permalink / raw)
To: peter.maydell; +Cc: berrange, armbru, mdroth, qemu-devel, stefanha, jsnow
Patchew URL: https://patchew.org/QEMU/20200206173040.17337-1-peter.maydell@linaro.org/
Hi,
This series failed the docker-quick@centos7 build test. Please find the testing commands and
their output below. If you have Docker installed, you can probably reproduce it
locally.
=== TEST SCRIPT BEGIN ===
#!/bin/bash
make docker-image-centos7 V=1 NETWORK=1
time make docker-test-quick@centos7 SHOW_ENV=1 J=14 NETWORK=1
=== TEST SCRIPT END ===
CC tests/test-qapi-commands.o
CC tests/test-string-input-visitor.o
CC tests/test-string-output-visitor.o
doc-good FAIL
--- /tmp/qemu-test/src/tests/qapi-schema/doc-good.out
+++
@@ -1,199 +0,0 @@
---
+++
@@ -0,0 +1 @@
+doc-good.json:104:1: unexpected de-indent
make: *** [check-tests/qapi-schema/frontend] Error 1
make: *** Waiting for unfinished jobs....
CC tests/test-qmp-event.o
Traceback (most recent call last):
---
raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['sudo', '-n', 'docker', 'run', '--label', 'com.qemu.instance.uuid=ac8e8dbf593c42e385721554759cb252', '-u', '1003', '--security-opt', 'seccomp=unconfined', '--rm', '-e', 'TARGET_LIST=', '-e', 'EXTRA_CONFIGURE_OPTS=', '-e', 'V=', '-e', 'J=14', '-e', 'DEBUG=', '-e', 'SHOW_ENV=1', '-e', 'CCACHE_DIR=/var/tmp/ccache', '-v', '/home/patchew2/.cache/qemu-docker-ccache:/var/tmp/ccache:z', '-v', '/var/tmp/patchew-tester-tmp-y9h_kw4r/src/docker-src.2020-02-06-14.53.51.11537:/var/tmp/qemu:z,ro', 'qemu:centos7', '/var/tmp/qemu/run', 'test-quick']' returned non-zero exit status 2.
filter=--filter=label=com.qemu.instance.uuid=ac8e8dbf593c42e385721554759cb252
make[1]: *** [docker-run] Error 1
make[1]: Leaving directory `/var/tmp/patchew-tester-tmp-y9h_kw4r/src'
make: *** [docker-run-test-quick@centos7] Error 2
real 2m17.651s
user 0m7.653s
The full log is available at
http://patchew.org/logs/20200206173040.17337-1-peter.maydell@linaro.org/testing.docker-quick@centos7/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (31 preceding siblings ...)
2020-02-06 19:56 ` no-reply
@ 2020-02-07 17:00 ` Markus Armbruster
2020-02-07 17:10 ` Peter Maydell
2020-02-10 0:34 ` Aleksandar Markovic
33 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-07 17:00 UTC (permalink / raw)
To: Peter Maydell
Cc: John Snow, Daniel P. Berrangé,
qemu-devel, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> This series switches all our QAPI doc comments over from
> texinfo format to rST.
>
> The basic approach is somewhat similar to how we deal with kerneldoc
> and hxtool: we have a custom Sphinx extension which is passed a
> filename which is the json file it should run the QAPI parser over and
> generate documentation for. Unlike 'kerneldoc' but somewhat like
> hxtool, I have chosed to generate documentation by generating a tree
> of docutils nodes, rather than by generating rST source that is then
> fed to the rST parser to generate docutils nodes. Individual lumps of
> doc comment go to the rST parser, but the structured parts we render
> directly. This makes it easier to get the structure and heading level
> nesting correct.
>
> Rather than trying to exactly handle all the existing comments I have
> opted (as Markus suggested) to tweak them where this seemed more
> sensible than contorting the rST generator to deal with
> weirdnesses. The principal changes are:
> * whitespace is now significant, and multiline definitions must have
> their second and subsequent lines indented to match the first line
> * general rST format markup is permitted, not just the small set of
> markup the old texinfo generator handled. For most things (notably
> bulleted and itemized lists) the old format is the same as rST was.
> * Specific things that might trip people up:
> - instead of *bold* and _italic_ rST has **bold** and *italic*
Actually, qapi-code-gen.txt documents and doc.py implements *strong* and
_emphasis_. Texinfo commonly renders them as bold and italic when the
output format supports that. rST has **strong** and *emphasis*.
Your series adjusts emphasis markup for rST [PATCH 18]. Since it
doesn't touch strong markup, strong silently becomes emphasis. I guess
that's okay, perhaps even an improvement, but double-checking the actual
uses of this markup wouldn't hurt.
> - lists need a preceding and following blank line
> - a lone literal '*' will need to be backslash-escaped to
> avoid a rST syntax error
> * the old leading '|' for example (literal text) blocks is replaced
> by the standard rST '::' literal block.
> * headings and subheadings must now be in a freeform documentation
> comment of their own
Can we simply use rST instead? See my review of PATCH 18.
> * we support arbitrary levels of sub- and sub-sub-heading, not just a
> main and sub-heading like the old texinfo generator
> * as a special case, @foo is retained and is equivalent to ``foo``
Apart from these remarks, your changes look sensible to me right now. I
hope they'll still look that way when I'm done reviewing :)
[...]
^ permalink raw reply [flat|nested] 77+ messages in thread* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-07 17:00 ` Markus Armbruster
@ 2020-02-07 17:10 ` Peter Maydell
2020-02-08 14:15 ` Markus Armbruster
0 siblings, 1 reply; 77+ messages in thread
From: Peter Maydell @ 2020-02-07 17:10 UTC (permalink / raw)
To: Markus Armbruster
Cc: John Snow, Daniel P. Berrangé,
QEMU Developers, Stefan Hajnoczi, Michael Roth
On Fri, 7 Feb 2020 at 17:00, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > This series switches all our QAPI doc comments over from
> > texinfo format to rST.
> >
> > The basic approach is somewhat similar to how we deal with kerneldoc
> > and hxtool: we have a custom Sphinx extension which is passed a
> > filename which is the json file it should run the QAPI parser over and
> > generate documentation for. Unlike 'kerneldoc' but somewhat like
> > hxtool, I have chosed to generate documentation by generating a tree
> > of docutils nodes, rather than by generating rST source that is then
> > fed to the rST parser to generate docutils nodes. Individual lumps of
> > doc comment go to the rST parser, but the structured parts we render
> > directly. This makes it easier to get the structure and heading level
> > nesting correct.
> >
> > Rather than trying to exactly handle all the existing comments I have
> > opted (as Markus suggested) to tweak them where this seemed more
> > sensible than contorting the rST generator to deal with
> > weirdnesses. The principal changes are:
> > * whitespace is now significant, and multiline definitions must have
> > their second and subsequent lines indented to match the first line
> > * general rST format markup is permitted, not just the small set of
> > markup the old texinfo generator handled. For most things (notably
> > bulleted and itemized lists) the old format is the same as rST was.
> > * Specific things that might trip people up:
> > - instead of *bold* and _italic_ rST has **bold** and *italic*
>
> Actually, qapi-code-gen.txt documents and doc.py implements *strong* and
> _emphasis_. Texinfo commonly renders them as bold and italic when the
> output format supports that. rST has **strong** and *emphasis*.
>
> Your series adjusts emphasis markup for rST [PATCH 18]. Since it
> doesn't touch strong markup, strong silently becomes emphasis. I guess
> that's okay, perhaps even an improvement, but double-checking the actual
> uses of this markup wouldn't hurt.
Yeah, that would be a good plan.
git grep '\*[^*]*\*' qapi/*.json
(and eyeball-filtering out the false hits) shows just one use:
qapi/introspect.json:# Note: the QAPI schema is also used to help
define *internal*
I can put a patch on the end which converts that to **internal**
once the rST generator is in use.
> > - lists need a preceding and following blank line
> > - a lone literal '*' will need to be backslash-escaped to
> > avoid a rST syntax error
> > * the old leading '|' for example (literal text) blocks is replaced
> > by the standard rST '::' literal block.
> > * headings and subheadings must now be in a freeform documentation
> > comment of their own
>
> Can we simply use rST instead? See my review of PATCH 18.
No, we can't (see my reply to that review). In theory you could have
the heading syntax be a rST heading, but that is not feasible to
recognise in the Python script[*] and it gives the impression that
it is just an inline rST heading, not something that's more complicated
and structured.
[*] You'd need to manually re-implement the weird thing rST does
where practically any kind of underlining is valid and it figures
out which one means which depth by looking at the usage through
the whole document. You'd have to do bizarre stuff like running
through the entire set of doc comments once doing no output but
just looking at heading underline characters to guess which one
is which depth, and then once you'd figured that out you could
do it all over again actually generating the doc.
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-07 17:10 ` Peter Maydell
@ 2020-02-08 14:15 ` Markus Armbruster
2020-02-08 14:59 ` Peter Maydell
0 siblings, 1 reply; 77+ messages in thread
From: Markus Armbruster @ 2020-02-08 14:15 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 7 Feb 2020 at 17:00, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > This series switches all our QAPI doc comments over from
>> > texinfo format to rST.
>> >
>> > The basic approach is somewhat similar to how we deal with kerneldoc
>> > and hxtool: we have a custom Sphinx extension which is passed a
>> > filename which is the json file it should run the QAPI parser over and
>> > generate documentation for. Unlike 'kerneldoc' but somewhat like
>> > hxtool, I have chosed to generate documentation by generating a tree
>> > of docutils nodes, rather than by generating rST source that is then
>> > fed to the rST parser to generate docutils nodes. Individual lumps of
>> > doc comment go to the rST parser, but the structured parts we render
>> > directly. This makes it easier to get the structure and heading level
>> > nesting correct.
>> >
>> > Rather than trying to exactly handle all the existing comments I have
>> > opted (as Markus suggested) to tweak them where this seemed more
>> > sensible than contorting the rST generator to deal with
>> > weirdnesses. The principal changes are:
>> > * whitespace is now significant, and multiline definitions must have
>> > their second and subsequent lines indented to match the first line
>> > * general rST format markup is permitted, not just the small set of
>> > markup the old texinfo generator handled. For most things (notably
>> > bulleted and itemized lists) the old format is the same as rST was.
>> > * Specific things that might trip people up:
>> > - instead of *bold* and _italic_ rST has **bold** and *italic*
>>
>> Actually, qapi-code-gen.txt documents and doc.py implements *strong* and
>> _emphasis_. Texinfo commonly renders them as bold and italic when the
>> output format supports that. rST has **strong** and *emphasis*.
>>
>> Your series adjusts emphasis markup for rST [PATCH 18]. Since it
>> doesn't touch strong markup, strong silently becomes emphasis. I guess
>> that's okay, perhaps even an improvement, but double-checking the actual
>> uses of this markup wouldn't hurt.
>
> Yeah, that would be a good plan.
> git grep '\*[^*]*\*' qapi/*.json
> (and eyeball-filtering out the false hits) shows just one use:
>
> qapi/introspect.json:# Note: the QAPI schema is also used to help
> define *internal*
>
> I can put a patch on the end which converts that to **internal**
> once the rST generator is in use.
I wrote that one, and I think changing it from strong to emphasis is an
improvement. Let's point to it in the commit message, and call it a
day.
>> > - lists need a preceding and following blank line
>> > - a lone literal '*' will need to be backslash-escaped to
>> > avoid a rST syntax error
>> > * the old leading '|' for example (literal text) blocks is replaced
>> > by the standard rST '::' literal block.
>> > * headings and subheadings must now be in a freeform documentation
>> > comment of their own
>>
>> Can we simply use rST instead? See my review of PATCH 18.
>
> No, we can't (see my reply to that review). In theory you could have
> the heading syntax be a rST heading, but that is not feasible to
> recognise in the Python script[*] and it gives the impression that
> it is just an inline rST heading, not something that's more complicated
> and structured.
>
> [*] You'd need to manually re-implement the weird thing rST does
> where practically any kind of underlining is valid and it figures
> out which one means which depth by looking at the usage through
> the whole document. You'd have to do bizarre stuff like running
> through the entire set of doc comments once doing no output but
> just looking at heading underline characters to guess which one
> is which depth, and then once you'd figured that out you could
> do it all over again actually generating the doc.
I understand the difficulty of parsing rST (Paolo called it "the Perl of
markup languages" for a reason). What I don't yet understand is (1) why
we need to recognize the document structure of doc comments, and (2) why
we can do that by recognizing '=' markup, but ignore the native rST
document structure markup.
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-08 14:15 ` Markus Armbruster
@ 2020-02-08 14:59 ` Peter Maydell
0 siblings, 0 replies; 77+ messages in thread
From: Peter Maydell @ 2020-02-08 14:59 UTC (permalink / raw)
To: Markus Armbruster
Cc: Daniel P. Berrangé,
John Snow, QEMU Developers, Stefan Hajnoczi, Michael Roth
On Sat, 8 Feb 2020 at 14:16, Markus Armbruster <armbru@redhat.com> wrote:
> I understand the difficulty of parsing rST (Paolo called it "the Perl of
> markup languages" for a reason). What I don't yet understand is (1) why
> we need to recognize the document structure of doc comments, and (2) why
> we can do that by recognizing '=' markup, but ignore the native rST
> document structure markup.
I think we're completely at cross purposes here, so there's
something I've not managed to communicate clearly.
We don't need to recognize the document structure of doc
comments, indeed my implementation does not -- it just
throws a doc comment at the rST parser to handle.
We *do* need to recognize the structure *of the document*
(ie that it does have a thing with a heading "Block devices"
that contains another thing with a heading "Background jobs"
that in turn contains documentation for JobType, JobStatus....)
so that when we're building up our tree of docutils node
objects we know when we need to create a new 'section'
node and give it a title 'Block devices' and which of
the various section nodes in the tree should have all
the nodes that make up the documentation of 'JobType'
added to it.
In order to achieve this separation (don't care about
document structure inside lumps of rST, but do want to
know what the overall section/subsection structure of
the document is), this patchset pulls the identification
of the document structure (heading/subheadings) completely
out of being something you might find in the middle of
a doc comment, and makes them their own
special kind of markup:
##
# = This is a heading
##
(In my head I find I'm thinking of this as "not actually
a doc comment", which is probably where some of my
lack of clarity is coming from, since syntactically
speaking and from the point of view of qapi/parser.py
that is a sort of doc comment.)
I suppose that there's an argument that the identification
of headings and subheadings should really be done in
qapi/parser.py, so that instead of
vis = QAPISchemaGenRSTVisitor(self)
vis.visit_begin(schema)
for doc in schema.docs:
if doc.symbol:
vis.symbol(doc, schema.lookup_entity(doc.symbol))
else:
vis.freeform(doc)
you would have something more like
vis = QAPISchemaGenRSTVisitor(self)
vis.visit_begin(schema)
for doc in schema.docs:
if doc.symbol:
vis.symbol(doc, schema.lookup_entity(doc.symbol))
else if doc.is_section_header:
vis.start_new_section(doc)
else:
vis.freeform(doc)
(with the identification of headers and pulling out of
what level of nesting this header is and what its text
is done in parser.py)
thanks
-- PMM
^ permalink raw reply [flat|nested] 77+ messages in thread
* Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo
2020-02-06 17:30 [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
` (32 preceding siblings ...)
2020-02-07 17:00 ` Markus Armbruster
@ 2020-02-10 0:34 ` Aleksandar Markovic
33 siblings, 0 replies; 77+ messages in thread
From: Aleksandar Markovic @ 2020-02-10 0:34 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrangé,
Markus Armbruster, Michael Roth, qemu-devel, Stefan Hajnoczi,
John Snow
[-- Attachment #1: Type: text/plain, Size: 548 bytes --]
On Thursday, February 6, 2020, Peter Maydell <peter.maydell@linaro.org>
wrote:
>
> > This series switches all our QAPI doc > > > comments over from
> > texinfo format to rST.
>
>
Regardeless of the outcome of the discussions over this series, I just want
to say that I support it as a potential user of the document (there is no
"Supported-by:" mark or similar, so this is all I can do). Also, as a
general participant in QEMU community, I seems to me this is a significant
step in shaping up QEMU documentation.
Best regards,
Aleksandar
>
>
[-- Attachment #2: Type: text/html, Size: 963 bytes --]
^ permalink raw reply [flat|nested] 77+ messages in thread