[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop
From: |
Markus Armbruster |
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 |
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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
---
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
- [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list, (continued)
- [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 12/49] qapi2texi: Fix up output around #optional, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 04/49] qapi: Make doc comments optional where we don't need them, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 20/49] qapi: Use raw strings for regular expressions consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 09/49] qapi: Clean up build of generated documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 27/49] qapi2texi: Include member type in generated documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 24/49] qapi2texi: Explain enum value undocumentedness more clearly, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 17/49] qapi: Conjure up QAPIDoc.ArgSection for undocumented members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr,
Markus Armbruster <=
- [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType', Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags, Markus Armbruster, 2017/03/16