[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns"
From: |
Markus Armbruster |
Subject: |
[PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns" section |
Date: |
Tue, 27 Feb 2024 12:39:10 +0100 |
Change "'Returns:' is only valid for commands" to "'Returns' section
is only valid for commands".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/parser.py | 5 +++--
tests/qapi-schema/doc-invalid-return.err | 2 +-
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index bfc47cf3cb..e4c2259e39 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -716,8 +716,9 @@ def connect_feature(self, feature: 'QAPISchemaFeature') ->
None:
def check_expr(self, expr: QAPIExpression) -> None:
if self.returns and 'command' not in expr:
- raise QAPISemError(self.returns.info,
- "'Returns:' is only valid for commands")
+ raise QAPISemError(
+ self.returns.info,
+ "'Returns' section is only valid for commands")
def check(self) -> None:
diff --git a/tests/qapi-schema/doc-invalid-return.err
b/tests/qapi-schema/doc-invalid-return.err
index 3d9e71c2b3..aafd57b135 100644
--- a/tests/qapi-schema/doc-invalid-return.err
+++ b/tests/qapi-schema/doc-invalid-return.err
@@ -1 +1 @@
-doc-invalid-return.json:6: 'Returns:' is only valid for commands
+doc-invalid-return.json:6: 'Returns' section is only valid for commands
--
2.43.0
- [PATCH 00/13] Subject: [PATCH 00/15] qapi: Improve command response documentation, Markus Armbruster, 2024/02/27
- [PATCH 01/13] qapi: Memorize since & returns sections, Markus Armbruster, 2024/02/27
- [PATCH 03/13] qapi: New documentation section tag "Errors", Markus Armbruster, 2024/02/27
- [PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns" section,
Markus Armbruster <=
- [PATCH 13/13] qapi: Reject "Returns" section when command doesn't return anything, Markus Armbruster, 2024/02/27
- [PATCH 04/13] qapi: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/02/27
- [PATCH 08/13] qga/qapi-schema: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/02/27
- [PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency, Markus Armbruster, 2024/02/27
- [PATCH 05/13] qapi: Delete useless "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 10/13] qga/qapi-schema: Clean up "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 12/13] qga/qapi-schema: Fix guest-set-memory-blocks documentation, Markus Armbruster, 2024/02/27
- [PATCH 09/13] qga/qapi-schema: Delete useless "Returns" sections, Markus Armbruster, 2024/02/27
- [PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands, Markus Armbruster, 2024/02/27
- [PATCH 06/13] qapi: Clean up "Returns" sections, Markus Armbruster, 2024/02/27