[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 2/8] docs/devel/qapi-code-gen: Fix a missing 'may', clarify Schema
From: |
Markus Armbruster |
Subject: |
[PULL 2/8] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo |
Date: |
Thu, 23 Feb 2023 13:23:21 +0100 |
Documentation of enumeration value conditions lacks a 'may'. Fix
that.
Clarify SchemaInfo documentation for struct and union types.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230213132009.918801-3-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
---
docs/devel/qapi-code-gen.rst | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 566640edf8..23e7f2fb1c 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -818,8 +818,8 @@ member 'bar' ::
A union's discriminator may not be conditional.
-Likewise, individual enumeration values be conditional. This requires
-the longhand form of ENUM-VALUE_.
+Likewise, individual enumeration values may be conditional. This
+requires the longhand form of ENUM-VALUE_.
Example: an enum type with unconditional value 'foo' and conditional
value 'bar' ::
@@ -1158,9 +1158,8 @@ Example: the SchemaInfo for EVENT_C from section Events_
::
Type "q_obj-EVENT_C-arg" is an implicitly defined object type with
the two members from the event's definition.
-The SchemaInfo for struct and union types has meta-type "object".
-
-The SchemaInfo for a struct type has variant member "members".
+The SchemaInfo for struct and union types has meta-type "object" and
+variant member "members".
The SchemaInfo for a union type additionally has variant members "tag"
and "variants".
--
2.39.0
- [PULL 0/8] QAPI patches patches for 2023-02-23, Markus Armbruster, 2023/02/23
- [PULL 2/8] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo,
Markus Armbruster <=
- [PULL 7/8] qapi: remove _JSONObject, Markus Armbruster, 2023/02/23
- [PULL 6/8] qapi/parser: add QAPIExpression type, Markus Armbruster, 2023/02/23
- [PULL 1/8] docs/devel/qapi-code-gen: Belatedly update features documentation, Markus Armbruster, 2023/02/23
- [PULL 4/8] qapi: update pylint configuration, Markus Armbruster, 2023/02/23
- [PULL 3/8] qapi: Update flake8 config, Markus Armbruster, 2023/02/23
- [PULL 5/8] qapi: Add minor typing workaround for 3.6, Markus Armbruster, 2023/02/23
- [PULL 8/8] qapi: remove JSON value FIXME, Markus Armbruster, 2023/02/23
- Re: [PULL 0/8] QAPI patches patches for 2023-02-23, Peter Maydell, 2023/02/24