From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Subject: [Qemu-devel] [PULL for 2.9 06/49] docs/qapi-code-gen.txt: Drop confusing reference to 'gen'
Date: Thu, 16 Mar 2017 07:27:22 +0100 [thread overview]
Message-ID: <1489645685-4750-7-git-send-email-armbru@redhat.com> (raw)
In-Reply-To: <1489645685-4750-1-git-send-email-armbru@redhat.com>
Section "Commands" qualifies its rules on permitted argument and
return types "with one exception noted below when 'gen' is used". The
note went away in commit 2d21291. Clean up the dangling references.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1489582656-31133-5-git-send-email-armbru@redhat.com>
---
docs/qapi-code-gen.txt | 18 ++++++++----------
1 file changed, 8 insertions(+), 10 deletions(-)
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 4b64ee7..5532b60 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -558,22 +558,20 @@ The 'data' argument maps to the "arguments" dictionary passed in as
part of a Client JSON Protocol command. The 'data' member is optional
and defaults to {} (an empty dictionary). If present, it must be the
string name of a complex type, or a dictionary that declares an
-anonymous type with the same semantics as a 'struct' expression, with
-one exception noted below when 'gen' is used.
+anonymous type with the same semantics as a 'struct' expression.
The 'returns' member describes what will appear in the "return" member
of a Client JSON Protocol reply on successful completion of a command.
The member is optional from the command declaration; if absent, the
"return" member will be an empty dictionary. If 'returns' is present,
it must be the string name of a complex or built-in type, a
-one-element array containing the name of a complex or built-in type,
-with one exception noted below when 'gen' is used. Although it is
-permitted to have the 'returns' member name a built-in type or an
-array of built-in types, any command that does this cannot be extended
-to return additional information in the future; thus, new commands
-should strongly consider returning a dictionary-based type or an array
-of dictionaries, even if the dictionary only contains one member at the
-present.
+one-element array containing the name of a complex or built-in type.
+Although it is permitted to have the 'returns' member name a built-in
+type or an array of built-in types, any command that does this cannot
+be extended to return additional information in the future; thus, new
+commands should strongly consider returning a dictionary-based type or
+an array of dictionaries, even if the dictionary only contains one
+member at the present.
All commands in Client JSON Protocol use a dictionary to report
failure, with no way to specify that in QAPI. Where the error return
--
2.7.4
next prev parent reply other threads:[~2017-03-16 6:28 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-16 6:27 [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 01/49] qapi2texi: change texi formatters Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 02/49] qmp: allow setting properties to empty string in qmp-shell Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 03/49] qapi: Factor QAPISchemaParser._include() out of .__init__() Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 04/49] qapi: Make doc comments optional where we don't need them Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 05/49] qapi: Back out doc comments added just to please qapi.py Markus Armbruster
2017-03-16 6:27 ` Markus Armbruster [this message]
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 08/49] qapi: Have each QAPI schema declare its name rule violations Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 09/49] qapi: Clean up build of generated documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 10/49] tests/qapi-schema: Cover empty union base Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 11/49] qapi: Fix to reject empty union base gracefully Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 12/49] qapi2texi: Fix up output around #optional Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType' Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 16/49] qapi: Prepare for requiring more complete documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 17/49] qapi: Conjure up QAPIDoc.ArgSection for undocumented members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 19/49] qapi: The #optional tag is redundant, drop Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 20/49] qapi: Use raw strings for regular expressions consistently Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 24/49] qapi2texi: Explain enum value undocumentedness " Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 27/49] qapi2texi: Include member type in generated documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 28/49] qapi2texi: Generate reference to base type members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 37/49] tests/qapi-schema: Rename doc-bad-args to doc-bad-command-arg Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 38/49] tests/qapi-schema: Improve coverage of bogus member docs Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 43/49] qapi: Factor add_name() calls out of the meta conditional Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 44/49] qapi: enum_types is a list used like a dict, make it one Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 45/49] qapi: struct_types " Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 46/49] qapi: union_types " Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 47/49] qapi: Drop unused .check_clash() parameter schema Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 49/49] qapi: Fix a misleading parser error message Markus Armbruster
2017-03-16 14:22 ` [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1489645685-4750-7-git-send-email-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).