| Message ID | 1489385927-6735-5-git-send-email-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
On 03/13/2017 01:18 AM, Markus Armbruster wrote: > 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> > --- > docs/qapi-code-gen.txt | 18 ++++++++---------- > 1 file changed, 8 insertions(+), 10 deletions(-) > Reviewed-by: Eric Blake <eblake@redhat.com>
Hi On Mon, Mar 13, 2017 at 10:20 AM Markus Armbruster <armbru@redhat.com> wrote: > 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: Marc-André Lureau <marcandre.lureau@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 88de5c7..d9c1f91 100644 > --- a/docs/qapi-code-gen.txt > +++ b/docs/qapi-code-gen.txt > @@ -555,22 +555,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 > > > -- Marc-André Lureau
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt index 88de5c7..d9c1f91 100644 --- a/docs/qapi-code-gen.txt +++ b/docs/qapi-code-gen.txt @@ -555,22 +555,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
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> --- docs/qapi-code-gen.txt | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-)