[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind'
From: |
Markus Armbruster |
Subject: |
[PATCH] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind' |
Date: |
Thu, 21 Dec 2023 15:57:27 +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>
---
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 7f78183cd4..972b21a5aa 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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind',
Markus Armbruster <=