qemu/doc-non-first-section.err at 134b443512825bed401b6e141447b8cdc22d2efe - qemu - SynapseOS git

mirrors/qemu

Markus Armbruster 56c64dd60a qapi: Reject section heading in the middle of a doc comment

docs/devel/qapi-code-gen.txt claims "A heading line must be the first
line of the documentation comment block" since commit
55ec69f8b1 (docs/devel/qapi-code-gen.txt: Update to new rST backend
conventions).  Not true, we have code to make it work anywhere in a
free-form doc comment: commit dcdc07a97c (qapi: Make section headings
start a new doc comment block).

Make it true, for simplicity's sake.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240216145841.2099240-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

2024-02-26 10:43:56 +01:00

2 lines

79 B

Plaintext

Raw Blame History

doc-non-first-section.json:5:1: '=' heading must come first in a comment block