summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Armbruster2022-05-10 08:16:45 +0200
committerMarkus Armbruster2022-05-16 07:29:50 +0200
commit1524559f58b1fe14e9b1c9b5be09a82696867eb1 (patch)
treef803b4f00a2efe1c5b3c4dd30c89b5fcbbbb2e53
parentqapi/expr: Enforce feature naming rules again (diff)
downloadqemu-1524559f58b1fe14e9b1c9b5be09a82696867eb1.tar.gz
qemu-1524559f58b1fe14e9b1c9b5be09a82696867eb1.tar.xz
qemu-1524559f58b1fe14e9b1c9b5be09a82696867eb1.zip
docs/devel/qapi-code-gen: Belatedly document feature naming rules
Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20220510061645.3209195-3-armbru@redhat.com>
-rw-r--r--docs/devel/qapi-code-gen.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 7b968433a6..cd9b544376 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -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,
respectively.
-Command names, and member names within a type, should be all lower
-case with words separated by a hyphen. However, some existing older
-commands and complex types use underscore; when extending them,
-consistency is preferred over blindly avoiding underscore.
+Command names, member names within a type, and feature names should be
+all lower case with words separated by a hyphen. However, some
+existing older commands and complex types use underscore; when
+extending them, consistency is preferred over blindly avoiding
+underscore.
Event names should be ALL_CAPS with words separated by underscore.