| Message ID | 20240216145841.2099240-3-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Doc comment parsing & doc generation work | expand |
On Fri, Feb 16, 2024 at 03:58:26PM +0100, Markus Armbruster wrote: > We don't actually recognize the second 'Features:' line. Instead, we > treat it as an untagged section. > > If it was followed by feature description, we'd reject that like > "description of '@feat2:' follows a section". Less than clear. > > To be improved shortly. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > tests/qapi-schema/doc-duplicate-features.err | 0 > tests/qapi-schema/doc-duplicate-features.json | 11 ++++++++++ > tests/qapi-schema/doc-duplicate-features.out | 22 +++++++++++++++++++ > tests/qapi-schema/meson.build | 1 + > 4 files changed, 34 insertions(+) > create mode 100644 tests/qapi-schema/doc-duplicate-features.err > create mode 100644 tests/qapi-schema/doc-duplicate-features.json > create mode 100644 tests/qapi-schema/doc-duplicate-features.out Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> With regards, Daniel
diff --git a/tests/qapi-schema/doc-duplicate-features.err b/tests/qapi-schema/doc-duplicate-features.err new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/qapi-schema/doc-duplicate-features.json b/tests/qapi-schema/doc-duplicate-features.json new file mode 100644 index 0000000000..a4d559e740 --- /dev/null +++ b/tests/qapi-schema/doc-duplicate-features.json @@ -0,0 +1,11 @@ +# Duplicate 'Features:' line + +## +# @foo: +# +# Features: +# @feat: mumble +# +# Features: +## +{ 'command': 'foo', 'features': ['feat'] } diff --git a/tests/qapi-schema/doc-duplicate-features.out b/tests/qapi-schema/doc-duplicate-features.out new file mode 100644 index 0000000000..43bfe1034b --- /dev/null +++ b/tests/qapi-schema/doc-duplicate-features.out @@ -0,0 +1,22 @@ +module ./builtin +object q_empty +enum QType + prefix QTYPE + member none + member qnull + member qnum + member qstring + member qdict + member qlist + member qbool +module doc-duplicate-features.json +command foo None -> None + gen=True success_response=True boxed=False oob=False preconfig=False + feature feat +doc symbol=foo + body= + + feature=feat +mumble + section=None +Features: diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build index 44a9385563..4c714c792f 100644 --- a/tests/qapi-schema/meson.build +++ b/tests/qapi-schema/meson.build @@ -66,6 +66,7 @@ schemas = [ 'doc-bad-union-member.json', 'doc-before-include.json', 'doc-before-pragma.json', + 'doc-duplicate-features.json', 'doc-duplicated-arg.json', 'doc-duplicated-return.json', 'doc-duplicated-since.json',
We don't actually recognize the second 'Features:' line. Instead, we treat it as an untagged section. If it was followed by feature description, we'd reject that like "description of '@feat2:' follows a section". Less than clear. To be improved shortly. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- tests/qapi-schema/doc-duplicate-features.err | 0 tests/qapi-schema/doc-duplicate-features.json | 11 ++++++++++ tests/qapi-schema/doc-duplicate-features.out | 22 +++++++++++++++++++ tests/qapi-schema/meson.build | 1 + 4 files changed, 34 insertions(+) create mode 100644 tests/qapi-schema/doc-duplicate-features.err create mode 100644 tests/qapi-schema/doc-duplicate-features.json create mode 100644 tests/qapi-schema/doc-duplicate-features.out