| commit | 56c64dd60aebb9c856ab63de74c9e81acd079436 | |
| author | Markus Armbruster <armbru@redhat.com> | |
| Fri, 16 Feb 2024 14:58:33 +0000 (16 15:58 +0100) | ||
| committer | Markus Armbruster <armbru@redhat.com> | |
| Mon, 26 Feb 2024 09:43:56 +0000 (26 10:43 +0100) | ||
| tree | d7b98825495c13fad60afb087a49566c98504ff6 | treesnapshot (tar.gz zip) |
| parent | 31c54b92ad0816ab1c4eddaf4b60c0b17a75dfc9 | commitdiff |
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
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 <armbru@redhat.com>
Message-ID: <20240216145841.2099240-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
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 <armbru@redhat.com>
Message-ID: <20240216145841.2099240-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
| scripts/qapi/parser.py | diffblobblamehistory | |
| tests/qapi-schema/doc-good.json | diffblobblamehistory | |
| tests/qapi-schema/doc-non-first-section.err | [new file with mode: 0644] | blob |
| tests/qapi-schema/doc-non-first-section.json | [new file with mode: 0644] | blob |
| tests/qapi-schema/doc-non-first-section.out | [new file with mode: 0644] | blob |