[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Ki
From: |
Markus Armbruster |
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 |
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
- [PULL 0/8] QAPI patches patches for 2024-01-26, Markus Armbruster, 2024/01/26
- [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs, Markus Armbruster, 2024/01/26
- [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind',
Markus Armbruster <=
- [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt, Markus Armbruster, 2024/01/26
- [PULL 8/8] qapi: Fix malformed "Since:" section tags (again), Markus Armbruster, 2024/01/26
- [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref, Markus Armbruster, 2024/01/26
- [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt, Markus Armbruster, 2024/01/26
- [PULL 7/8] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/01/26
- [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation, Markus Armbruster, 2024/01/26
- Re: [PULL 0/8] QAPI patches patches for 2024-01-26, Peter Maydell, 2024/01/26