[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 10/11] docs/devel/qapi-code-gen: Belatedly document feature naming
From: |
Markus Armbruster |
Subject: |
[PULL 10/11] docs/devel/qapi-code-gen: Belatedly document feature naming rules |
Date: |
Mon, 16 May 2022 09:35:21 +0200 |
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20220510061645.3209195-3-armbru@redhat.com>
---
docs/devel/qapi-code-gen.rst | 9 +++++----
1 file 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.
--
2.35.3
- [PULL 00/11] QAPI patches patches for 2022-05-16, Markus Armbruster, 2022/05/16
- [PULL 06/11] qapi: Drop unnecessary empty lines outside of comments, Markus Armbruster, 2022/05/16
- [PULL 01/11] qapi: Fix malformed "Since:" section tags, Markus Armbruster, 2022/05/16
- [PULL 02/11] qapi: Drop stray trailing symbol, Markus Armbruster, 2022/05/16
- [PULL 11/11] qapi/pragma: Tidy up comments, Markus Armbruster, 2022/05/16
- [PULL 08/11] qapi: Stop using whitespace for alignment in comments, Markus Armbruster, 2022/05/16
- [PULL 03/11] qapi: Fix comment indentation, Markus Armbruster, 2022/05/16
- [PULL 09/11] qapi/expr: Enforce feature naming rules again, Markus Armbruster, 2022/05/16
- [PULL 07/11] qapi: Drop unnecessary whitespace in comments, Markus Armbruster, 2022/05/16
- [PULL 04/11] qapi: Add missing separators between sections, Markus Armbruster, 2022/05/16
- [PULL 10/11] docs/devel/qapi-code-gen: Belatedly document feature naming rules,
Markus Armbruster <=
- [PULL 05/11] qapi: Drop unnecessary empty lines in comments, Markus Armbruster, 2022/05/16
- Re: [PULL 00/11] QAPI patches patches for 2022-05-16, Richard Henderson, 2022/05/16