qapi: Reject section heading in the middle of a doc comment
docs/devel/qapi-code-gen.txt claims "A heading line must be the first line of the documentation comment block" since commit55ec69f8b1
(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: commitdcdc07a97c
(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:
parent
31c54b92ad
commit
56c64dd60a
@ -440,9 +440,9 @@ class QAPISchemaParser:
|
||||
self,
|
||||
"unexpected '=' markup in definition documentation")
|
||||
if cur_doc.body.text:
|
||||
cur_doc.end_comment()
|
||||
docs.append(cur_doc)
|
||||
cur_doc = QAPIDoc(self, info)
|
||||
raise QAPIParseError(
|
||||
self,
|
||||
"'=' heading must come first in a comment block")
|
||||
cur_doc.append(self.val)
|
||||
self.accept(False)
|
||||
|
||||
|
@ -9,7 +9,9 @@
|
||||
|
||||
##
|
||||
# = Section
|
||||
#
|
||||
##
|
||||
|
||||
##
|
||||
# == Subsection
|
||||
#
|
||||
# *with emphasis*
|
||||
|
1
tests/qapi-schema/doc-non-first-section.err
Normal file
1
tests/qapi-schema/doc-non-first-section.err
Normal file
@ -0,0 +1 @@
|
||||
doc-non-first-section.json:5:1: '=' heading must come first in a comment block
|
6
tests/qapi-schema/doc-non-first-section.json
Normal file
6
tests/qapi-schema/doc-non-first-section.json
Normal file
@ -0,0 +1,6 @@
|
||||
# = section must be first line
|
||||
|
||||
##
|
||||
#
|
||||
# = Not first
|
||||
##
|
0
tests/qapi-schema/doc-non-first-section.out
Normal file
0
tests/qapi-schema/doc-non-first-section.out
Normal file
Loading…
Reference in New Issue
Block a user