motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-26 20:03:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Recognize section tags and 'Features:' only after blank line

Browse source 
Putting a blank line before section tags and 'Features:' is good,
existing practice.  Enforce it.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240216145841.2099240-12-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-16 15:58:35 +01:00
parent d23055b8db
commit 66227e9047
9 changed files with 32 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -986,16 +986,17 @@ indented like this::
Extensions added after the definition was first released carry a
"(since x.y.z)" comment.
The feature descriptions must be preceded by a line "Features:", like
this::
The feature descriptions must be preceded by a blank line and then a
line "Features:", like this::
#
# Features:
#
# @feature: Description text
A tagged section starts with one of the following words:
"Note:"/"Notes:", "Since:", "Example:"/"Examples:", "Returns:",
"TODO:". The section ends with the start of a new section.
A tagged section begins with a paragraph that starts with one of the
following words: "Note:"/"Notes:", "Since:", "Example:"/"Examples:",
"Returns:", "TODO:". It ends with the start of a new section.
The second and subsequent lines of tagged sections must be indented
like this::
@ -1086,8 +1087,10 @@ need to line up with each other, like this::
# or cache associativity unknown)
# (since 5.0)
Section tags are case-sensitive and end with a colon. Good example::
Section tags are case-sensitive and end with a colon. They are only
recognized after a blank line. Good example::
#
# Since: 7.1
Bad examples (all ordinary paragraphs)::