[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 13/18] qapi: Reject "Returns" section when command doesn't return
From: |
Markus Armbruster |
Subject: |
[PULL 13/18] qapi: Reject "Returns" section when command doesn't return anything |
Date: |
Mon, 4 Mar 2024 07:32:31 +0100 |
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-14-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.44.0
- [PULL 14/18] docs/devel/writing-monitor-commands: Repair a decade of rot, (continued)
- [PULL 14/18] docs/devel/writing-monitor-commands: Repair a decade of rot, Markus Armbruster, 2024/03/04
- [PULL 17/18] qapi: New strv_from_str_list(), Markus Armbruster, 2024/03/04
- [PULL 10/18] qga/qapi-schema: Clean up "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 08/18] qga/qapi-schema: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/03/04
- [PULL 16/18] qapi: New QAPI_LIST_LENGTH(), Markus Armbruster, 2024/03/04
- [PULL 05/18] qapi: Delete useless "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 11/18] qga/qapi-schema: Tweak documentation of fsfreeze commands, Markus Armbruster, 2024/03/04
- [PULL 07/18] qapi/yank: Tweak @yank's error description for consistency, Markus Armbruster, 2024/03/04
- [PULL 06/18] qapi: Clean up "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 15/18] docs/devel/writing-monitor-commands: Minor improvements, Markus Armbruster, 2024/03/04
- [PULL 13/18] qapi: Reject "Returns" section when command doesn't return anything,
Markus Armbruster <=
- [PULL 04/18] qapi: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/03/04
- [PULL 18/18] migration: simplify exec migration functions, Markus Armbruster, 2024/03/04
- Re: [PULL 00/18] QAPI patches patches for 2024-03-04, Peter Maydell, 2024/03/05