From e8518c92b0b143cfeb4251d3185f262c2d2b6ee9 Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Thu, 19 Jan 2017 10:06:44 +0100 Subject: [PATCH 1/3] build-sys: Minor qapi doc generation target cleanups MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move makeinfo flags from MAKEINFO to MAKEINFOFLAGS. Fix the call of quiet-command for target qemu-ga-qapi.texi. Both messed up in commit 56e8bdd. Cc: Marc-André Lureau Signed-off-by: Markus Armbruster Message-Id: <1484816804-12598-1-git-send-email-armbru@redhat.com> Reviewed-by: Marc-André Lureau --- Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index c166d2d3ea..1e5cb1934d 100644 --- a/Makefile +++ b/Makefile @@ -542,8 +542,8 @@ ui/console-gl.o: $(SRC_PATH)/ui/console-gl.c \ ui/shader/texture-blit-vert.h ui/shader/texture-blit-frag.h # documentation -MAKEINFO=makeinfo -D 'VERSION $(VERSION)' -MAKEINFOFLAGS=--no-split --number-sections +MAKEINFO=makeinfo +MAKEINFOFLAGS=--no-split --number-sections -D 'VERSION $(VERSION)' TEXIFLAG=$(if $(V),,--quiet) --command='@set VERSION $(VERSION)' %.html: %.texi @@ -573,7 +573,7 @@ qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@") qemu-qapi.texi: $(qapi-modules) $(qapi-py) - $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN" "$@") + $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN","$@") qemu-ga-qapi.texi: $(SRC_PATH)/qga/qapi-schema.json $(qapi-py) $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi2texi.py $< > $@,"GEN","$@") From 5d0c7f4f9e2d1fed53fcb2733aede71c9dcaf871 Mon Sep 17 00:00:00 2001 From: Stefan Weil Date: Sun, 22 Jan 2017 15:54:07 +0100 Subject: [PATCH 2/3] qapi: Remove unwanted commas after #optional keyword We don't want that commas to be part of the generated documentation, so remove them. Signed-off-by: Stefan Weil Message-Id: <20170122145407.27476-1-sw@weilnetz.de> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- qapi-schema.json | 4 ++-- qapi/block-core.json | 10 +++++----- qapi/event.json | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index ac55f4a41b..82fabc6e24 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1506,7 +1506,7 @@ # # The network connection information for server # -# @auth: #optional, authentication method +# @auth: #optional authentication method # # Since: 2.1 ## @@ -1694,7 +1694,7 @@ # # Information about a SPICE server # -# @auth: #optional, authentication method +# @auth: #optional authentication method # # Since: 2.1 ## diff --git a/qapi/block-core.json b/qapi/block-core.json index 1b3e6eb0e8..932f5bb3b4 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -3126,10 +3126,10 @@ # # @filename: filename of the new image to be loaded # -# @format: #optional, format to open the new image with (defaults to +# @format: #optional format to open the new image with (defaults to # the probed format) # -# @read-only-mode: #optional, change the read-only mode of the device; defaults +# @read-only-mode: #optional change the read-only mode of the device; defaults # to 'retain' # # Since: 2.5 @@ -3208,10 +3208,10 @@ # corruption being detected. It should not be parsed by machine as it is # not guaranteed to be stable # -# @offset: #optional, if the corruption resulted from an image access, this is +# @offset: #optional if the corruption resulted from an image access, this is # the host's access offset into the image # -# @size: #optional, if the corruption resulted from an image access, this is +# @size: #optional if the corruption resulted from an image access, this is # the access size # # @fatal: if set, the image is marked corrupt and therefore unusable after this @@ -3302,7 +3302,7 @@ # # @speed: rate limit, bytes per second # -# @error: #optional, error message. Only present on failure. This field +# @error: #optional error message. Only present on failure. This field # contains a human-readable error message. There are no semantics # other than that streaming has failed and clients should not try to # interpret the error string diff --git a/qapi/event.json b/qapi/event.json index f3737b771f..7bf539b84d 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -186,7 +186,7 @@ # At this point, it's safe to reuse the specified device ID. Device removal can # be initiated by the guest or by HMP/QMP commands. # -# @device: #optional, device name +# @device: #optional device name # # @path: device path # @@ -209,7 +209,7 @@ # Emitted once until the 'query-rx-filter' command is executed, the first event # will always be emitted # -# @name: #optional, net client name +# @name: #optional net client name # # @path: device path # @@ -531,7 +531,7 @@ # # @type: quorum operation type (Since 2.6) # -# @error: #optional, error message. Only present on failure. This field +# @error: #optional error message. Only present on failure. This field # contains a human-readable error message. There are no semantics other # than that the block layer reported an error and clients should not # try to interpret the error string. From 7a8c153f0e59cccdc0425cdebe43765008def01a Mon Sep 17 00:00:00 2001 From: Lin Ma Date: Wed, 25 Jan 2017 13:27:03 +0800 Subject: [PATCH 3/3] qmp: Fix argument name in error message of device-list-properties The argument is called "typename", not "name". [Thanks to Markus for correcting the commit message] Signed-off-by: Lin Ma Message-Id: <20170125052703.23571-1-lma@suse.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- qmp.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/qmp.c b/qmp.c index 0028f0b30e..886059ef94 100644 --- a/qmp.c +++ b/qmp.c @@ -531,12 +531,12 @@ DevicePropertyInfoList *qmp_device_list_properties(const char *typename, klass = object_class_dynamic_cast(klass, TYPE_DEVICE); if (klass == NULL) { - error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name", TYPE_DEVICE); + error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "typename", TYPE_DEVICE); return NULL; } if (object_class_is_abstract(klass)) { - error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name", + error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "typename", "non-abstract device type"); return NULL; }