ShuriZma
/
xqemu
mirror of https://github.com/xqemu/xqemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/qapi-code-gen.txt: Drop confusing reference to 'gen' 

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>
This commit is contained in:
Markus Armbruster 2017-03-15 13:56:53 +01:00
parent 87c16dceca
commit 700dc9f503
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/qapi-code-gen.txt
View File

@ -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 part of a Client JSON Protocol command. The 'data' member is optional
and defaults to {} (an empty dictionary). If present, it must be the and defaults to {} (an empty dictionary). If present, it must be the
string name of a complex type, or a dictionary that declares an string name of a complex type, or a dictionary that declares an
anonymous type with the same semantics as a 'struct' expression, with anonymous type with the same semantics as a 'struct' expression.
one exception noted below when 'gen' is used.
The 'returns' member describes what will appear in the "return" member The 'returns' member describes what will appear in the "return" member
of a Client JSON Protocol reply on successful completion of a command. of a Client JSON Protocol reply on successful completion of a command.
The member is optional from the command declaration; if absent, the The member is optional from the command declaration; if absent, the
"return" member will be an empty dictionary. If 'returns' is present, "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 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, 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 Although it is permitted to have the 'returns' member name a built-in
permitted to have the 'returns' member name a built-in type or an type or an array of built-in types, any command that does this cannot
array of built-in types, any command that does this cannot be extended be extended to return additional information in the future; thus, new
to return additional information in the future; thus, new commands commands should strongly consider returning a dictionary-based type or
should strongly consider returning a dictionary-based type or an array an array of dictionaries, even if the dictionary only contains one
of dictionaries, even if the dictionary only contains one member at the member at the present.
present.
All commands in Client JSON Protocol use a dictionary to report All commands in Client JSON Protocol use a dictionary to report
failure, with no way to specify that in QAPI. Where the error return failure, with no way to specify that in QAPI. Where the error return