[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 03/30] docs/devel/qapi-code-gen: Clarify allow-oob introspecti
From: |
Markus Armbruster |
Subject: |
[PATCH v2 03/30] docs/devel/qapi-code-gen: Clarify allow-oob introspection |
Date: |
Tue, 3 Mar 2020 17:34:38 +0100 |
Mention SchemaInfo variant member "allow-oob" defaults to false.
Signed-off-by: Markus Armbruster <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 v2 02/30] qapi: Belatedly update doc comment for @wait deprecation, (continued)
- [PATCH v2 02/30] qapi: Belatedly update doc comment for @wait deprecation, Markus Armbruster, 2020/03/03
- [PATCH v2 10/30] tests/test-qmp-event: Check event is actually emitted, Markus Armbruster, 2020/03/03
- [PATCH v2 09/30] tests/test-qmp-event: Use qobject_is_equal(), Markus Armbruster, 2020/03/03
- [PATCH v2 16/30] qapi/schema: Change _make_features() to a take feature list, Markus Armbruster, 2020/03/03
- [PATCH v2 19/30] qapi/schema: Call QAPIDoc.connect_member() in just one place, Markus Armbruster, 2020/03/03
- [PATCH v2 13/30] qapi: Consistently put @features parameter right after @ifcond, Markus Armbruster, 2020/03/03
- [PATCH v2 04/30] docs/devel/qapi-code-gen: Document 'features' introspection, Markus Armbruster, 2020/03/03
- [PATCH v2 05/30] tests/test-qmp-cmds: Factor out qmp_dispatch() test helpers, Markus Armbruster, 2020/03/03
- [PATCH v2 11/30] qapi/schema: Clean up around QAPISchemaEntity.connect_doc(), Markus Armbruster, 2020/03/03
- [PATCH v2 24/30] qapi: Replace qmp_dispatch()'s TODO comment by an explanation, Markus Armbruster, 2020/03/03
- [PATCH v2 03/30] docs/devel/qapi-code-gen: Clarify allow-oob introspection,
Markus Armbruster <=
- [PATCH v2 25/30] qapi: New special feature flag "deprecated", Markus Armbruster, 2020/03/03
- [PATCH v2 27/30] qemu-options: New -compat to set policy for deprecated interfaces, Markus Armbruster, 2020/03/03
- [PATCH v2 07/30] tests/test-qmp-cmds: Simplify test data setup, Markus Armbruster, 2020/03/03
- [PATCH v2 18/30] qapi/schema: Rename QAPISchemaObjectType{Variant, Variants}, Markus Armbruster, 2020/03/03
- [PATCH v2 08/30] tests/test-qmp-event: Simplify test data setup, Markus Armbruster, 2020/03/03
- [PATCH v2 01/30] qemu-doc: Belatedly document QMP command arg & result deprecation, Markus Armbruster, 2020/03/03
- [PATCH v2 22/30] qapi: Simplify how qmp_dispatch() deals with QCO_NO_SUCCESS_RESP, Markus Armbruster, 2020/03/03
- [PATCH v2 12/30] qapi: Add feature flags to remaining definitions, Markus Armbruster, 2020/03/03
- [PATCH v2 15/30] qapi/introspect: Factor out _make_tree(), Markus Armbruster, 2020/03/03
- [PATCH v2 30/30] qapi: New -compat deprecated-input=crash, Markus Armbruster, 2020/03/03