mirror of
https://github.com/qemu/qemu.git
synced 2025-07-22 18:27:05 +00:00
qapi: lift restriction on using '=' in doc blocks
We reject lines starting with '=' in definition documentation. This made sense when such lines were headings in free-form documentation, but not in definition documentation. Before the previous commit, lines starting with '=' were headings in free-form documentation, and rejected in definition documentation, where such headings could not work. The previous commit dropped the headings feature from free-form documentation, because we can simply use plain rST headings. Rejecting them in definition documentation no longer makes sense, so drop that, too. Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20250618165353.1980365-6-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Amend commit message to explain why] Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:

committed by
Markus Armbruster

parent
6c10778826
commit
62c4dc4b69
@ -584,10 +584,6 @@ class QAPISchemaParser:
|
||||
doc.append_line(text)
|
||||
line = self.get_doc_indented(doc)
|
||||
no_more_args = True
|
||||
elif line.startswith('='):
|
||||
raise QAPIParseError(
|
||||
self,
|
||||
"unexpected '=' markup in definition documentation")
|
||||
else:
|
||||
# plain paragraph
|
||||
doc.ensure_untagged_section(self.info)
|
||||
|
@ -1 +0,0 @@
|
||||
doc-bad-section.json:5:1: unexpected '=' markup in definition documentation
|
@ -1,10 +0,0 @@
|
||||
# = section within an expression comment
|
||||
|
||||
##
|
||||
# @Enum:
|
||||
# == No good here
|
||||
# @one: The _one_ {and only}
|
||||
#
|
||||
# @two is undocumented
|
||||
##
|
||||
{ 'enum': 'Enum', 'data': [ 'one', 'two' ] }
|
@ -61,7 +61,6 @@ schemas = [
|
||||
'doc-bad-event-arg.json',
|
||||
'doc-bad-feature.json',
|
||||
'doc-bad-indent.json',
|
||||
'doc-bad-section.json',
|
||||
'doc-bad-symbol.json',
|
||||
'doc-bad-union-member.json',
|
||||
'doc-before-include.json',
|
||||
|
Reference in New Issue
Block a user