diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-02-13 14:20:09 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-02-23 12:49:09 +0100 |
| commit | c2985e38f0a5e00bfb2540b43531baf485de2ee2 (patch) | |
| tree | 8b970cc9ca793b55de2b12de5366abfac09174a8 | |
| parent | ebf1b324e8d1b05be5327f3e6a13d8570f7fd1e3 (diff) | |
docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
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>
| -rw-r--r-- | docs/devel/qapi-code-gen.rst | 9 |
1 files 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". |