From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: richard.henderson@linaro.org
Subject: [PULL 10/11] docs/devel/qapi-code-gen: Belatedly document feature naming rules
Date: Mon, 16 May 2022 09:35:21 +0200 [thread overview]
Message-ID: <20220516073522.3880774-11-armbru@redhat.com> (raw)
In-Reply-To: <20220516073522.3880774-1-armbru@redhat.com>
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
next prev parent reply other threads:[~2022-05-16 7:48 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-16 7:35 [PULL 00/11] QAPI patches patches for 2022-05-16 Markus Armbruster
2022-05-16 7:35 ` [PULL 01/11] qapi: Fix malformed "Since:" section tags Markus Armbruster
2022-05-16 7:35 ` [PULL 02/11] qapi: Drop stray trailing symbol Markus Armbruster
2022-05-16 7:35 ` [PULL 03/11] qapi: Fix comment indentation Markus Armbruster
2022-05-16 7:35 ` [PULL 04/11] qapi: Add missing separators between sections Markus Armbruster
2022-05-16 7:35 ` [PULL 05/11] qapi: Drop unnecessary empty lines in comments Markus Armbruster
2022-05-16 7:35 ` [PULL 06/11] qapi: Drop unnecessary empty lines outside of comments Markus Armbruster
2022-05-16 7:35 ` [PULL 07/11] qapi: Drop unnecessary whitespace in comments Markus Armbruster
2022-05-16 7:35 ` [PULL 08/11] qapi: Stop using whitespace for alignment " Markus Armbruster
2022-05-16 7:35 ` [PULL 09/11] qapi/expr: Enforce feature naming rules again Markus Armbruster
2022-05-16 7:35 ` Markus Armbruster [this message]
2022-05-16 7:35 ` [PULL 11/11] qapi/pragma: Tidy up comments Markus Armbruster
2022-05-16 16:48 ` [PULL 00/11] QAPI patches patches for 2022-05-16 Richard Henderson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220516073522.3880774-11-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).