motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 04:13:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/devel/qapi-code-gen: Belatedly document feature naming rules

Browse source 
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20220510061645.3209195-3-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2022-05-10 08:16:45 +02:00
parent 9e191d3368
commit 1524559f58
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/devel/qapi-code-gen.rst
View file

@ -739,10 +739,11 @@ Type names ending with ``Kind`` or ``List`` are reserved for the
generator, which uses them for implicit union enums and array types, generator, which uses them for implicit union enums and array types,
respectively. respectively.
Command names, and member names within a type, should be all lower Command names, member names within a type, and feature names should be
case with words separated by a hyphen. However, some existing older all lower case with words separated by a hyphen. However, some
commands and complex types use underscore; when extending them, existing older commands and complex types use underscore; when
consistency is preferred over blindly avoiding underscore. extending them, consistency is preferred over blindly avoiding
underscore.
Event names should be ALL_CAPS with words separated by underscore. Event names should be ALL_CAPS with words separated by underscore.