diff options
| author | John Snow <jsnow@redhat.com> | 2025-06-18 12:53:53 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-07-14 10:08:27 +0200 |
| commit | 62c4dc4b69ef7dcfcc476913a9c5fc15329e0290 (patch) | |
| tree | e8ecbb695e5e28af83d616dc4ce9bdb39a10e02b | |
| parent | 6c10778826a873b9012d95e63298a6f879debcaa (diff) | |
| download | qemu-62c4dc4b69ef7dcfcc476913a9c5fc15329e0290.zip qemu-62c4dc4b69ef7dcfcc476913a9c5fc15329e0290.tar.gz qemu-62c4dc4b69ef7dcfcc476913a9c5fc15329e0290.tar.bz2 | |
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>
| -rw-r--r-- | scripts/qapi/parser.py | 4 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-section.err | 1 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-section.json | 10 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-section.out | 0 | ||||
| -rw-r--r-- | tests/qapi-schema/meson.build | 1 |
5 files changed, 0 insertions, 16 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index aad7e24..d43a123 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) diff --git a/tests/qapi-schema/doc-bad-section.err b/tests/qapi-schema/doc-bad-section.err deleted file mode 100644 index 785cacc..0000000 --- a/tests/qapi-schema/doc-bad-section.err +++ /dev/null @@ -1 +0,0 @@ -doc-bad-section.json:5:1: unexpected '=' markup in definition documentation diff --git a/tests/qapi-schema/doc-bad-section.json b/tests/qapi-schema/doc-bad-section.json deleted file mode 100644 index 8175d95..0000000 --- a/tests/qapi-schema/doc-bad-section.json +++ /dev/null @@ -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' ] } diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out deleted file mode 100644 index e69de29..0000000 --- a/tests/qapi-schema/doc-bad-section.out +++ /dev/null diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build index 9577178..c47025d 100644 --- a/tests/qapi-schema/meson.build +++ b/tests/qapi-schema/meson.build @@ -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', |