summary refs log tree commit diff stats
path: root/scripts/qapi
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-06-18 12:53:53 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-07-14 10:08:27 +0200
commit62c4dc4b69ef7dcfcc476913a9c5fc15329e0290 (patch)
treee8ecbb695e5e28af83d616dc4ce9bdb39a10e02b /scripts/qapi
parent6c10778826a873b9012d95e63298a6f879debcaa (diff)
downloadfocaccia-qemu-62c4dc4b69ef7dcfcc476913a9c5fc15329e0290.tar.gz
focaccia-qemu-62c4dc4b69ef7dcfcc476913a9c5fc15329e0290.zip
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>
Diffstat (limited to 'scripts/qapi')
-rw-r--r--scripts/qapi/parser.py4
1 files changed, 0 insertions, 4 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index aad7e249f8..d43a123cd7 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -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)