From 1524559f58b1fe14e9b1c9b5be09a82696867eb1 Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Tue, 10 May 2022 08:16:45 +0200 Subject: docs/devel/qapi-code-gen: Belatedly document feature naming rules Signed-off-by: Markus Armbruster Message-Id: <20220510061645.3209195-3-armbru@redhat.com> --- docs/devel/qapi-code-gen.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'docs') 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. -- cgit v1.2.3