diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-12-21 15:57:27 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-01-26 07:04:53 +0100 |
| commit | 1110fbc35fab45b0b73eebd33a75fb792895eeb1 (patch) | |
| tree | 9f0fc5ac4ab805a30bfe6cbde83a9d325636c963 /docs | |
| parent | 5bab95dc74d43bbb28c6a96d24c810a664432057 (diff) | |
| download | qemu-1110fbc35fab45b0b73eebd33a75fb792895eeb1.zip qemu-1110fbc35fab45b0b73eebd33a75fb792895eeb1.tar.gz qemu-1110fbc35fab45b0b73eebd33a75fb792895eeb1.tar.bz2 | |
docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind'
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/qapi-code-gen.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index ea82285..0c6f420 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 |