[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 03/34] docs/devel/qapi-code-gen: Clarify allow-oob introspecti
From: |
Markus Armbruster |
Subject: |
[PATCH v4 03/34] docs/devel/qapi-code-gen: Clarify allow-oob introspection |
Date: |
Tue, 17 Mar 2020 12:54:28 +0100 |
Mention SchemaInfo variant member "allow-oob" defaults to false.
Signed-off-by: Markus Armbruster <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
---
docs/devel/qapi-code-gen.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 59d6973e1e..5906602504 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"
--
2.21.1
- [PATCH v4 00/34] Configurable policy for handling deprecated interfaces, Markus Armbruster, 2020/03/17
- [PATCH v4 03/34] docs/devel/qapi-code-gen: Clarify allow-oob introspection,
Markus Armbruster <=
- [PATCH v4 01/34] qemu-doc: Belatedly document QMP command arg & result deprecation, Markus Armbruster, 2020/03/17
- [PATCH v4 04/34] docs/devel/qapi-code-gen: Document 'features' introspection, Markus Armbruster, 2020/03/17
- [PATCH v4 08/34] tests/test-qmp-event: Simplify test data setup, Markus Armbruster, 2020/03/17
- [PATCH v4 05/34] tests/test-qmp-cmds: Factor out qmp_dispatch() test helpers, Markus Armbruster, 2020/03/17
- [PATCH v4 02/34] qapi: Belatedly update doc comment for @wait deprecation, Markus Armbruster, 2020/03/17
- [PATCH v4 06/34] tests/test-qmp-cmds: Check responses more thoroughly, Markus Armbruster, 2020/03/17
- [PATCH v4 07/34] tests/test-qmp-cmds: Simplify test data setup, Markus Armbruster, 2020/03/17
- [PATCH v4 16/34] qapi/schema: Change _make_features() to a take feature list, Markus Armbruster, 2020/03/17
- [PATCH v4 23/34] qapi: Simplify how qmp_dispatch() gets the request ID, Markus Armbruster, 2020/03/17