qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
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 01/13] qapi: Memorize since & returns sections
Date: Tue, 27 Feb 2024 12:39:09 +0100	[thread overview]
Message-ID: <20240227113921.236097-2-armbru@redhat.com> (raw)
In-Reply-To: <20240227113921.236097-1-armbru@redhat.com>

This is chiefly to make code that looks up these sections easier to
read.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/parser.py | 31 +++++++++++++++++--------------
 1 file changed, 17 insertions(+), 14 deletions(-)

diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 11707418fb..bfc47cf3cb 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -639,6 +639,10 @@ def __init__(self, info: QAPISourceInfo, symbol: Optional[str] = None):
         # dicts mapping parameter/feature names to their description
         self.args: Dict[str, QAPIDoc.ArgSection] = {}
         self.features: Dict[str, QAPIDoc.ArgSection] = {}
+        # a command's "Returns" section
+        self.returns: Optional[QAPIDoc.Section] = None
+        # "Since" section
+        self.since: Optional[QAPIDoc.Section] = None
         # sections other than .body, .args, .features
         self.sections: List[QAPIDoc.Section] = []
 
@@ -660,14 +664,17 @@ def ensure_untagged_section(self, info: QAPISourceInfo) -> None:
         self.all_sections.append(section)
 
     def new_tagged_section(self, info: QAPISourceInfo, tag: str) -> None:
-        if tag in ('Returns', 'Since'):
-            for section in self.all_sections:
-                if isinstance(section, self.ArgSection):
-                    continue
-                if section.tag == tag:
-                    raise QAPISemError(
-                        info, "duplicated '%s' section" % tag)
         section = self.Section(info, tag)
+        if tag == 'Returns':
+            if self.returns:
+                raise QAPISemError(
+                    info, "duplicated '%s' section" % tag)
+            self.returns = section
+        elif tag == 'Since':
+            if self.since:
+                raise QAPISemError(
+                    info, "duplicated '%s' section" % tag)
+            self.since = section
         self.sections.append(section)
         self.all_sections.append(section)
 
@@ -708,13 +715,9 @@ 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:
-            sec = next((sec for sec in self.sections
-                        if sec.tag == 'Returns'),
-                       None)
-            if sec:
-                raise QAPISemError(sec.info,
-                                   "'Returns:' is only valid for commands")
+        if self.returns and 'command' not in expr:
+            raise QAPISemError(self.returns.info,
+                               "'Returns:' is only valid for commands")
 
     def check(self) -> None:
 
-- 
2.43.0



  reply	other threads:[~2024-02-27 11:40 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 ` Markus Armbruster [this message]
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 ` [PATCH 13/13] qapi: Reject "Returns" section when command doesn't return anything Markus Armbruster
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-2-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).