qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Subject: [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr
Date: Thu, 16 Mar 2017 07:27:56 +0100	[thread overview]
Message-ID: <1489645685-4750-41-git-send-email-armbru@redhat.com> (raw)
In-Reply-To: <1489645685-4750-1-git-send-email-armbru@redhat.com>

Move what's left in check_docs() to check_expr().  Delegate the actual
checking to new QAPIDoc.check_expr().

QAPIDoc.expr is now unused; drop it.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-39-git-send-email-armbru@redhat.com>
---
 scripts/qapi.py | 27 ++++++++++-----------------
 1 file changed, 10 insertions(+), 17 deletions(-)

diff --git a/scripts/qapi.py b/scripts/qapi.py
index ca9926b..1aaae8e 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -138,8 +138,6 @@ class QAPIDoc(object):
         self.sections = []
         # the current section
         self.section = self.body
-        # associated expression (to be set by expression parser)
-        self.expr = None
 
     def has_section(self, name):
         """Return True if we have a section with this name."""
@@ -249,6 +247,11 @@ class QAPIDoc(object):
             self.args[member.name] = QAPIDoc.ArgSection(member.name)
         self.args[member.name].connect(member)
 
+    def check_expr(self, expr):
+        if self.has_section('Returns') and 'command' not in expr:
+            raise QAPISemError(self.info,
+                               "'Returns:' is only valid for commands")
+
     def check(self):
         bogus = [name for name, section in self.args.iteritems()
                  if not section.member]
@@ -316,7 +319,6 @@ class QAPISchemaParser(object):
                         raise QAPISemError(
                             self.cur_doc.info,
                             "Expression documentation required")
-                    self.cur_doc.expr = expr
                     expr_elem['doc'] = self.cur_doc
                 self.exprs.append(expr_elem)
             self.cur_doc = None
@@ -984,6 +986,7 @@ def check_exprs(exprs):
     for expr_elem in exprs:
         expr = expr_elem['expr']
         info = expr_elem['info']
+        doc = expr_elem.get('doc')
 
         if 'enum' in expr:
             check_enum(expr, info)
@@ -1000,22 +1003,12 @@ def check_exprs(exprs):
         else:
             assert False, 'unexpected meta type'
 
+        if doc:
+            doc.check_expr(expr)
+
     return exprs
 
 
-def check_definition_doc(doc, expr, info):
-    if doc.has_section('Returns') and 'command' not in expr:
-        raise QAPISemError(info, "'Returns:' is only valid for commands")
-
-
-def check_docs(docs):
-    for doc in docs:
-        if doc.expr:
-            check_definition_doc(doc, doc.expr, doc.info)
-
-    return docs
-
-
 #
 # Schema compiler frontend
 #
@@ -1511,7 +1504,7 @@ class QAPISchema(object):
         try:
             parser = QAPISchemaParser(open(fname, 'r'))
             self.exprs = check_exprs(parser.exprs)
-            self.docs = check_docs(parser.docs)
+            self.docs = parser.docs
             self._entity_dict = {}
             self._predefining = True
             self._def_predefineds()
-- 
2.7.4

  parent reply	other threads:[~2017-03-16  6:28 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-16  6:27 [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 01/49] qapi2texi: change texi formatters Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 02/49] qmp: allow setting properties to empty string in qmp-shell Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 03/49] qapi: Factor QAPISchemaParser._include() out of .__init__() Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 04/49] qapi: Make doc comments optional where we don't need them Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 05/49] qapi: Back out doc comments added just to please qapi.py Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 06/49] docs/qapi-code-gen.txt: Drop confusing reference to 'gen' Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 08/49] qapi: Have each QAPI schema declare its name rule violations Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 09/49] qapi: Clean up build of generated documentation Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 10/49] tests/qapi-schema: Cover empty union base Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 11/49] qapi: Fix to reject empty union base gracefully Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 12/49] qapi2texi: Fix up output around #optional Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType' Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 16/49] qapi: Prepare for requiring more complete documentation Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 17/49] qapi: Conjure up QAPIDoc.ArgSection for undocumented members Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 19/49] qapi: The #optional tag is redundant, drop Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 20/49] qapi: Use raw strings for regular expressions consistently Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 24/49] qapi2texi: Explain enum value undocumentedness " Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 27/49] qapi2texi: Include member type in generated documentation Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 28/49] qapi2texi: Generate reference to base type members Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 37/49] tests/qapi-schema: Rename doc-bad-args to doc-bad-command-arg Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 38/49] tests/qapi-schema: Improve coverage of bogus member docs Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation Markus Armbruster
2017-03-16  6:27 ` Markus Armbruster [this message]
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types Markus Armbruster
2017-03-16  6:27 ` [Qemu-devel] [PULL for 2.9 43/49] qapi: Factor add_name() calls out of the meta conditional Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 44/49] qapi: enum_types is a list used like a dict, make it one Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 45/49] qapi: struct_types " Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 46/49] qapi: union_types " Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 47/49] qapi: Drop unused .check_clash() parameter schema Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier Markus Armbruster
2017-03-16  6:28 ` [Qemu-devel] [PULL for 2.9 49/49] qapi: Fix a misleading parser error message Markus Armbruster
2017-03-16 14:22 ` [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Peter Maydell

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=1489645685-4750-41-git-send-email-armbru@redhat.com \
    --to=armbru@redhat.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).