On Fri, Feb 16, 2024 at 03:58:33PM +0100, Markus Armbruster wrote: > docs/devel/qapi-code-gen.txt claims "A heading line must be the first > line of the documentation comment block" since commit > 55ec69f8b16 (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 dcdc07a97cb (qapi: Make section headings > start a new doc comment block). > > Make it true, for simplicity's sake. > > Signed-off-by: Markus Armbruster <arm...@redhat.com> > --- > scripts/qapi/parser.py | 6 +++--- > tests/qapi-schema/doc-good.json | 4 +++- > tests/qapi-schema/doc-non-first-section.err | 1 + > tests/qapi-schema/doc-non-first-section.json | 6 ++++++ > tests/qapi-schema/doc-non-first-section.out | 0 > 5 files changed, 13 insertions(+), 4 deletions(-) > create mode 100644 tests/qapi-schema/doc-non-first-section.err > create mode 100644 tests/qapi-schema/doc-non-first-section.json > create mode 100644 tests/qapi-schema/doc-non-first-section.out
Reviewed-by: Daniel P. Berrangé <berra...@redhat.com> With regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|