From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>
Subject: [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind'
Date: Fri, 26 Jan 2024 07:27:37 +0100 [thread overview]
Message-ID: <20240126062744.265588-2-armbru@redhat.com> (raw)
In-Reply-To: <20240126062744.265588-1-armbru@redhat.com>
We reserved type names ending with 'Kind' because a simple union
'SomeSimpleUnion' generated both a struct type SomeSimpleUnion and an
enum type SomeSimpleUnionKind. Gone since commit 4e99f4b12c0 (qapi:
Drop simple unions). The commit neglected to update the documentation
not to reserve type names ending with 'Kind'. Do that now.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20231221145727.835905-1-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
docs/devel/qapi-code-gen.rst | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index ea8228518c..0c6f4201bc 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -737,9 +737,8 @@ Types, commands, and events share a common namespace. Therefore,
generally speaking, type definitions should always use CamelCase for
user-defined type names, while built-in types are lowercase.
-Type names ending with ``Kind`` or ``List`` are reserved for the
-generator, which uses them for implicit union enums and array types,
-respectively.
+Type names ending with ``List`` are reserved for the generator, which
+uses them for array types.
Command names, member names within a type, and feature names should be
all lower case with words separated by a hyphen. However, some
--
2.43.0
next prev parent reply other threads:[~2024-01-26 6:29 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 6:27 [PULL 0/8] QAPI patches patches for 2024-01-26 Markus Armbruster
2024-01-26 6:27 ` Markus Armbruster [this message]
2024-01-26 6:27 ` [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Markus Armbruster
2024-01-26 6:27 ` [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Markus Armbruster
2024-01-26 6:27 ` [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation Markus Armbruster
2024-01-26 6:27 ` [PULL 7/8] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-01-26 6:27 ` [PULL 8/8] qapi: Fix malformed "Since:" section tags (again) Markus Armbruster
2024-01-26 13:10 ` [PULL 0/8] QAPI patches patches for 2024-01-26 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=20240126062744.265588-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@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).