]> www.infradead.org Git - users/dwmw2/qemu.git/commitdiff
docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
authorMarkus Armbruster <armbru@redhat.com>
Mon, 13 Feb 2023 13:20:09 +0000 (14:20 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Thu, 23 Feb 2023 11:49:09 +0000 (12:49 +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

index 566640edf81a1ee9d2d14c590f70c4483110abe0..23e7f2fb1c372fd91c3a4e70a130b535c3486b45 100644 (file)
@@ -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".