qapi: Improve error message for description following section

The error message is bad when the section is untagged. For instance, test case doc-interleaved-section produces "'@foobar:' can't follow 'Note' section", which is okay, but if we drop the "Note:" tag, we get "'@foobar:' can't follow 'None' section, which is bad. Change the error message to "description of '@foobar:' follows a section". Signed-off-by: Markus Armbruster <[email protected]> Message-Id: <[email protected]> Reviewed-by: Juan Quintela <[email protected]> [Conflict with commit 3e32dca resolved]
xzpeter · May 22, 2023 · 290e48e · 290e48e
1 parent aa222a8
commit 290e48e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
@@ -675,8 +675,8 @@ def _append_various_line(self, line: str) -> None:
         match = self._match_at_name_colon(line)
         if match:
             raise QAPIParseError(self._parser,
-                                 "'@%s:' can't follow '%s' section"
-                                 % (match.group(1), self.sections[0].name))
+                                 "description of '@%s:' follows a section"
+                                 % match.group(1))
         match = self._match_section_tag(line)
         if match:
             line = line[match.end():]

diff --git a/tests/qapi-schema/doc-interleaved-section.err b/tests/qapi-schema/doc-interleaved-section.err
@@ -1 +1 @@
-doc-interleaved-section.json:15:1: '@foobar:' can't follow 'Note' section
+doc-interleaved-section.json:15:1: description of '@foobar:' follows a section
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		doc-interleaved-section.json:15:1: '@foobar:' can't follow 'Note' section
		doc-interleaved-section.json:15:1: description of '@foobar:' follows a section