motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-04 16:23:55 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Reject section heading in the middle of a doc comment

Browse source 
docs/devel/qapi-code-gen.txt claims "A heading line must be the first
line of the documentation comment block" since commit
55ec69f8b1 (docs/devel/qapi-code-gen.txt: Update to new rST backend
conventions).  Not true, we have code to make it work anywhere in a
free-form doc comment: commit dcdc07a97c (qapi: Make section headings
start a new doc comment block).

Make it true, for simplicity's sake.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240216145841.2099240-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-16 15:58:33 +01:00
parent 31c54b92ad
commit 56c64dd60a
5 changed files with 13 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

1
tests/qapi-schema/doc-non-first-section.err Normal file
View file

@ -0,0 +1 @@
doc-non-first-section.json:5:1: '=' heading must come first in a comment block