summary refs log tree commit diff stats
path: root/scripts/qapi
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-09-30 16:57:09 -0400
committerMarkus Armbruster <armbru@redhat.com>2021-10-02 07:33:42 +0200
commit1e20a77576dedf1489ce1cdb6abc4b34663637a4 (patch)
tree15e69c3ecdd775924ea525b4b52c0ce7785dd134 /scripts/qapi
parentcd87c14cde5db42a2f13bfdbba1f3cbeb347a411 (diff)
downloadfocaccia-qemu-1e20a77576dedf1489ce1cdb6abc4b34663637a4.tar.gz
focaccia-qemu-1e20a77576dedf1489ce1cdb6abc4b34663637a4.zip
qapi/parser: clarify _end_section() logic
The "if self._section" clause in end_section is mysterious: In which
circumstances might we end a section when we don't have one?

QAPIDoc always expects there to be a "current section", only except
after a call to end_comment(). This actually *shouldn't* ever be 'None',
so let's remove that logic so I don't wonder why it's like this again in
three months.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210930205716.1148693-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/qapi')
-rw-r--r--scripts/qapi/parser.py22
1 files changed, 15 insertions, 7 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 23898ab1dc..82f1d952b1 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -718,13 +718,21 @@ class QAPIDoc:
         self.sections.append(self._section)
 
     def _end_section(self):
-        if self._section:
-            text = self._section.text = self._section.text.strip()
-            if self._section.name and (not text or text.isspace()):
-                raise QAPIParseError(
-                    self._parser,
-                    "empty doc section '%s'" % self._section.name)
-            self._section = None
+        assert self._section is not None
+
+        text = self._section.text = self._section.text.strip()
+
+        # Only the 'body' section is allowed to have an empty body.
+        # All other sections, including anonymous ones, must have text.
+        if self._section != self.body and not text:
+            # We do not create anonymous sections unless there is
+            # something to put in them; this is a parser bug.
+            assert self._section.name
+            raise QAPIParseError(
+                self._parser,
+                "empty doc section '%s'" % self._section.name)
+
+        self._section = None
 
     def _append_freeform(self, line):
         match = re.match(r'(@\S+:)', line)