diff mbox series

[2/2] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo

Message ID 20230213132009.918801-3-armbru@redhat.com
State New
Headers show
Series docs/devel/qapi-code-gen: Update features doc, minor improvements | expand

Commit Message

Markus Armbruster Feb. 13, 2023, 1:20 p.m. UTC 
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>
---
 docs/devel/qapi-code-gen.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

Comments

Eric Blake Feb. 13, 2023, 3:07 p.m. UTC | #1 
On Mon, Feb 13, 2023 at 02:20:09PM +0100, Markus Armbruster wrote:
> 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>
> ---
>  docs/devel/qapi-code-gen.rst | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>
diff mbox series

Patch

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".