diff options
author | John Snow <jsnow@redhat.com> | 2025-06-18 12:53:52 -0400 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2025-07-14 10:08:27 +0200 |
commit | 6c10778826a873b9012d95e63298a6f879debcaa (patch) | |
tree | 9707775416b8a85c047ef42facefb1c42eb1a3bd /scripts | |
parent | 8d789c8cdb8de2cae39f217b6c9607ac9c036c8c (diff) | |
download | qemu-6c10778826a873b9012d95e63298a6f879debcaa.zip qemu-6c10778826a873b9012d95e63298a6f879debcaa.tar.gz qemu-6c10778826a873b9012d95e63298a6f879debcaa.tar.bz2 |
docs/sphinx: remove special parsing for freeform sections
Remove the QAPI doc section heading syntax, use plain rST section
headings instead.
Tests and documentation are updated to match.
Interestingly, Plain rST headings work fine before this patch, except
for over- and underlining with '=', which the doc parser rejected as
invalid QAPI doc section heading in free-form comments.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250618165353.1980365-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Add more detail to commit message]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts')
-rw-r--r-- | scripts/qapi/parser.py | 7 |
1 files changed, 0 insertions, 7 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 949d9e8..aad7e24 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -597,22 +597,15 @@ class QAPISchemaParser: # Free-form documentation doc = QAPIDoc(info) doc.ensure_untagged_section(self.info) - first = True while line is not None: if match := self._match_at_name_colon(line): raise QAPIParseError( self, "'@%s:' not allowed in free-form documentation" % match.group(1)) - if line.startswith('='): - if not first: - raise QAPIParseError( - self, - "'=' heading must come first in a comment block") doc.append_line(line) self.accept(False) line = self.get_doc_line() - first = False self.accept() doc.end() |