From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com,
kkostiuk@redhat.com
Subject: [PATCH 13/13] qapi: Reject "Returns" section when command doesn't return anything
Date: Tue, 27 Feb 2024 12:39:21 +0100 [thread overview]
Message-ID: <20240227113921.236097-14-armbru@redhat.com> (raw)
In-Reply-To: <20240227113921.236097-1-armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/parser.py | 7 ++++++-
tests/qapi-schema/doc-invalid-return2.err | 1 +
tests/qapi-schema/doc-invalid-return2.json | 7 +++++++
tests/qapi-schema/doc-invalid-return2.out | 0
tests/qapi-schema/meson.build | 1 +
5 files changed, 15 insertions(+), 1 deletion(-)
create mode 100644 tests/qapi-schema/doc-invalid-return2.err
create mode 100644 tests/qapi-schema/doc-invalid-return2.json
create mode 100644 tests/qapi-schema/doc-invalid-return2.out
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index a32b2c7e7f..d8f76060b8 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -721,7 +721,12 @@ def connect_feature(self, feature: 'QAPISchemaFeature') -> None:
self.features[feature.name].connect(feature)
def check_expr(self, expr: QAPIExpression) -> None:
- if 'command' not in expr:
+ if 'command' in expr:
+ if self.returns and 'returns' not in expr:
+ raise QAPISemError(
+ self.returns.info,
+ "'Returns' section, but command doesn't return anything")
+ else:
if self.returns:
raise QAPISemError(
self.returns.info,
diff --git a/tests/qapi-schema/doc-invalid-return2.err b/tests/qapi-schema/doc-invalid-return2.err
new file mode 100644
index 0000000000..c3d0c7a452
--- /dev/null
+++ b/tests/qapi-schema/doc-invalid-return2.err
@@ -0,0 +1 @@
+doc-invalid-return2.json:5: 'Returns' section, but command doesn't return anything
diff --git a/tests/qapi-schema/doc-invalid-return2.json b/tests/qapi-schema/doc-invalid-return2.json
new file mode 100644
index 0000000000..37883d4fea
--- /dev/null
+++ b/tests/qapi-schema/doc-invalid-return2.json
@@ -0,0 +1,7 @@
+# Command doesn't return anything
+
+##
+# @foo:
+# Returns: blah
+##
+{ 'command': 'foo' }
diff --git a/tests/qapi-schema/doc-invalid-return2.out b/tests/qapi-schema/doc-invalid-return2.out
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build
index 4b8329d070..0f479d9317 100644
--- a/tests/qapi-schema/meson.build
+++ b/tests/qapi-schema/meson.build
@@ -79,6 +79,7 @@ schemas = [
'doc-invalid-end.json',
'doc-invalid-end2.json',
'doc-invalid-return.json',
+ 'doc-invalid-return2.json',
'doc-invalid-section.json',
'doc-invalid-start.json',
'doc-missing-colon.json',
--
2.43.0
next prev parent reply other threads:[~2024-02-27 11:41 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-27 11:39 [PATCH 00/13] Subject: [PATCH 00/15] qapi: Improve command response documentation Markus Armbruster
2024-02-27 11:39 ` [PATCH 01/13] qapi: Memorize since & returns sections Markus Armbruster
2024-02-27 11:39 ` [PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns" section Markus Armbruster
2024-02-27 11:39 ` [PATCH 03/13] qapi: New documentation section tag "Errors" Markus Armbruster
2024-02-27 11:39 ` [PATCH 04/13] qapi: Move error documentation to new "Errors" sections Markus Armbruster
2024-02-27 11:39 ` [PATCH 05/13] qapi: Delete useless "Returns" sections Markus Armbruster
2024-02-27 11:39 ` [PATCH 06/13] qapi: Clean up " Markus Armbruster
2024-02-27 11:39 ` [PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency Markus Armbruster
2024-02-27 11:39 ` [PATCH 08/13] qga/qapi-schema: Move error documentation to new "Errors" sections Markus Armbruster
2024-03-04 8:23 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 09/13] qga/qapi-schema: Delete useless "Returns" sections Markus Armbruster
2024-03-04 8:25 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 10/13] qga/qapi-schema: Clean up " Markus Armbruster
2024-03-04 8:24 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands Markus Armbruster
2024-03-04 8:21 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 12/13] qga/qapi-schema: Fix guest-set-memory-blocks documentation Markus Armbruster
2024-03-04 8:16 ` Konstantin Kostiuk
2024-02-27 11:39 ` Markus Armbruster [this message]
2024-03-11 15:37 ` [PATCH 00/13] Subject: [PATCH 00/15] qapi: Improve command response documentation Konstantin Kostiuk
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240227113921.236097-14-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=michael.roth@amd.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).