aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2017-03-15 13:57:23 +0100
committerMarkus Armbruster <armbru@redhat.com>2017-03-16 07:13:03 +0100
commit4ea7148e89deda8795b3233bc5ba8c4bf037230e (patch)
tree3afdbf32a2891efeb4b3c6d591bbe5a5e0acea97 /scripts
parent2d433236df5ab15d61a117c3d8e47a4abc651ce0 (diff)
downloadqemu-4ea7148e89deda8795b3233bc5ba8c4bf037230e.zip
qemu-4ea7148e89deda8795b3233bc5ba8c4bf037230e.tar.gz
qemu-4ea7148e89deda8795b3233bc5ba8c4bf037230e.tar.bz2
qapi: Move empty doc section checking to doc parser
Results in a more precise error location, but the real reason is emptying out check_docs() step by step. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <1489582656-31133-35-git-send-email-armbru@redhat.com>
Diffstat (limited to 'scripts')
-rw-r--r--scripts/qapi.py20
1 files changed, 14 insertions, 6 deletions
diff --git a/scripts/qapi.py b/scripts/qapi.py
index 4edcea1..648355e 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
@@ -512,6 +525,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:
@@ -1012,12 +1026,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)