| Message ID | 20240216145841.2099240-10-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | qapi: Doc comment parsing & doc generation work | expand |
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 <armbru@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é <berrange@redhat.com> With regards, Daniel
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index cc69f4f770..3aefec1c2b 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -440,9 +440,9 @@ def get_doc(self, info: QAPISourceInfo) -> List['QAPIDoc']: self, "unexpected '=' markup in definition documentation") if cur_doc.body.text: - cur_doc.end_comment() - docs.append(cur_doc) - cur_doc = QAPIDoc(self, info) + raise QAPIParseError( + self, + "'=' heading must come first in a comment block") cur_doc.append(self.val) self.accept(False) diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 24a84fe6d7..0479d16a01 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -9,7 +9,9 @@ ## # = Section -# +## + +## # == Subsection # # *with emphasis* diff --git a/tests/qapi-schema/doc-non-first-section.err b/tests/qapi-schema/doc-non-first-section.err new file mode 100644 index 0000000000..eeced2bca7 --- /dev/null +++ b/tests/qapi-schema/doc-non-first-section.err @@ -0,0 +1 @@ +doc-non-first-section.json:5:1: '=' heading must come first in a comment block diff --git a/tests/qapi-schema/doc-non-first-section.json b/tests/qapi-schema/doc-non-first-section.json new file mode 100644 index 0000000000..1590876061 --- /dev/null +++ b/tests/qapi-schema/doc-non-first-section.json @@ -0,0 +1,6 @@ +# = section must be first line + +## +# +# = Not first +## diff --git a/tests/qapi-schema/doc-non-first-section.out b/tests/qapi-schema/doc-non-first-section.out new file mode 100644 index 0000000000..e69de29bb2
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> --- 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