docs/devel/qapi-code-gen: Clarify allow-oob introspection
authorMarkus Armbruster <armbru@redhat.com>
Tue, 17 Mar 2020 11:54:28 +0000 (12:54 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 17 Mar 2020 18:58:34 +0000 (19:58 +0100)
Mention SchemaInfo variant member "allow-oob" defaults to false.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200317115459.31821-4-armbru@redhat.com>

docs/devel/qapi-code-gen.txt

index e73979e1828ded738afa4366500e1ae6c099d7ae..3ce03e6efaea4f03f5d63ade8d96767692549e2e 100644 (file)
@@ -988,9 +988,9 @@ The SchemaInfo for a command has meta-type "command", and variant
 members "arg-type", "ret-type" and "allow-oob".  On the wire, the
 "arguments" member of a client's "execute" command must conform to the
 object type named by "arg-type".  The "return" member that the server
-passes in a success response conforms to the type named by
-"ret-type".  When "allow-oob" is set, it means the command supports
-out-of-band execution.
+passes in a success response conforms to the type named by "ret-type".
+When "allow-oob" is true, it means the command supports out-of-band
+execution.  It defaults to false.
 
 If the command takes no arguments, "arg-type" names an object type
 without members.  Likewise, if the command returns nothing, "ret-type"