]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi: lift restriction on using '=' in doc blocks
authorJohn Snow <jsnow@redhat.com>
Wed, 18 Jun 2025 16:53:53 +0000 (12:53 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 14 Jul 2025 08:08:27 +0000 (10:08 +0200)
commit62c4dc4b69ef7dcfcc476913a9c5fc15329e0290
treee8ecbb695e5e28af83d616dc4ce9bdb39a10e02b
parent6c10778826a873b9012d95e63298a6f879debcaa
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>
scripts/qapi/parser.py
tests/qapi-schema/doc-bad-section.err [deleted file]
tests/qapi-schema/doc-bad-section.json [deleted file]
tests/qapi-schema/doc-bad-section.out [deleted file]
tests/qapi-schema/meson.build