From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>,
John Snow <jsnow@redhat.com>
Subject: [PULL 2/8] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
Date: Thu, 23 Feb 2023 13:23:21 +0100 [thread overview]
Message-ID: <20230223122327.1920247-3-armbru@redhat.com> (raw)
In-Reply-To: <20230223122327.1920247-1-armbru@redhat.com>
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
next prev parent reply other threads:[~2023-02-23 12:24 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-23 12:23 [PULL 0/8] QAPI patches patches for 2023-02-23 Markus Armbruster
2023-02-23 12:23 ` [PULL 1/8] docs/devel/qapi-code-gen: Belatedly update features documentation Markus Armbruster
2023-02-23 12:23 ` Markus Armbruster [this message]
2023-02-23 12:23 ` [PULL 3/8] qapi: Update flake8 config Markus Armbruster
2023-02-23 12:23 ` [PULL 4/8] qapi: update pylint configuration Markus Armbruster
2023-02-23 12:23 ` [PULL 5/8] qapi: Add minor typing workaround for 3.6 Markus Armbruster
2023-02-23 12:23 ` [PULL 6/8] qapi/parser: add QAPIExpression type Markus Armbruster
2023-02-23 12:23 ` [PULL 7/8] qapi: remove _JSONObject Markus Armbruster
2023-02-23 12:23 ` [PULL 8/8] qapi: remove JSON value FIXME Markus Armbruster
2023-02-24 15:07 ` [PULL 0/8] QAPI patches patches for 2023-02-23 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230223122327.1920247-3-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).