diff options
| author | Markus Armbruster <armbru@redhat.com> | 2020-03-17 12:54:28 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2020-03-17 19:58:34 +0100 |
| commit | ad52292ea14f20b5ad296e0dee8a2a801c77717e (patch) | |
| tree | 1d875899a7fac972c517b54aececaba7deb46e15 /docs | |
| parent | 0f365e3332a92c9f96f04691afb24a471368d33e (diff) | |
docs/devel/qapi-code-gen: Clarify allow-oob introspection
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/qapi-code-gen.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index e73979e182..3ce03e6efa 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -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" |