[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH for-2.9 34/47] qapi: Move empty doc section checking
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PATCH for-2.9 34/47] qapi: Move empty doc section checking to doc parser |
Date: |
Mon, 13 Mar 2017 07:18:34 +0100 |
Results in a more precise error location, but the real reason is
emptying out check_docs() step by step.
Signed-off-by: Markus Armbruster <address@hidden>
---
scripts/qapi.py | 20 ++++++++++++++------
tests/qapi-schema/doc-empty-section.err | 2 +-
2 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/scripts/qapi.py b/scripts/qapi.py
index 8d34651..e53701a 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -173,6 +173,9 @@ class QAPIDoc(object):
else:
self._append_freeform(line)
+ def end_comment(self):
+ self._end_section()
+
def _append_symbol_line(self, line):
name = line.split(' ', 1)[0]
@@ -200,6 +203,7 @@ class QAPIDoc(object):
raise QAPIParseError(self.parser,
"'@%s:' can't follow '%s' section"
% (name, self.sections[0].name))
+ self._end_section()
self.section = QAPIDoc.ArgSection(name)
self.args[name] = self.section
@@ -207,9 +211,18 @@ class QAPIDoc(object):
if name in ('Returns', 'Since') and self.has_section(name):
raise QAPIParseError(self.parser,
"Duplicated '%s' section" % name)
+ self._end_section()
self.section = QAPIDoc.Section(name)
self.sections.append(self.section)
+ def _end_section(self):
+ if self.section:
+ contents = str(self.section)
+ if self.section.name and (not contents or contents.isspace()):
+ raise QAPIParseError(self.parser, "Empty doc section '%s'"
+ % self.section.name)
+ self.section = None
+
def _append_freeform(self, line):
in_arg = isinstance(self.section, QAPIDoc.ArgSection)
if (in_arg and self.section.content
@@ -507,6 +520,7 @@ class QAPISchemaParser(object):
if self.val != '##':
raise QAPIParseError(self, "Junk after '##' at end of "
"documentation comment")
+ doc.end_comment()
self.accept()
return doc
else:
@@ -1007,12 +1021,6 @@ def check_definition_doc(doc, expr, info):
def check_docs(docs):
for doc in docs:
- for section in doc.args.values() + doc.sections:
- content = str(section)
- if not content or content.isspace():
- raise QAPISemError(doc.info,
- "Empty doc section '%s'" % section.name)
-
if doc.expr:
check_definition_doc(doc, doc.expr, doc.info)
diff --git a/tests/qapi-schema/doc-empty-section.err
b/tests/qapi-schema/doc-empty-section.err
index 00ad625..b61e4a7 100644
--- a/tests/qapi-schema/doc-empty-section.err
+++ b/tests/qapi-schema/doc-empty-section.err
@@ -1 +1 @@
-tests/qapi-schema/doc-empty-section.json:3: Empty doc section 'Note'
+tests/qapi-schema/doc-empty-section.json:7:1: Empty doc section 'Note'
--
2.7.4
- [Qemu-devel] [PATCH for-2.9 33/47] qapi: Improve error message on @NAME: in free-form doc, (continued)
- [Qemu-devel] [PATCH for-2.9 33/47] qapi: Improve error message on @NAME: in free-form doc, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 43/47] qapi: struct_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 44/47] qapi: union_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 38/47] qapi: Eliminate check_docs() and drop QAPIDoc.expr, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 35/47] tests/qapi-schema: Rename doc-bad-args to doc-bad-command-arg, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 34/47] qapi: Move empty doc section checking to doc parser,
Markus Armbruster <=
- [Qemu-devel] [PATCH for-2.9 31/47] qapi: Fix detection of doc / expression mismatch, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 41/47] qapi: Factor add_name() calls out of the meta conditional, Markus Armbruster, 2017/03/13