summary refs log tree commit diff stats
path: root/scripts/qapi
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2023-05-10 16:16:37 +0200
committerMarkus Armbruster <armbru@redhat.com>2023-05-22 10:03:26 +0200
commit290e48e8f1ec975c100520fb697b0ae7300d0fb3 (patch)
tree6862e8b6b02915ef5491a600afb4f9e47bd5f281 /scripts/qapi
parentaa222a8e4f975284b3f8f131653a4114b3d333b3 (diff)
downloadfocaccia-qemu-290e48e8f1ec975c100520fb697b0ae7300d0fb3.tar.gz
focaccia-qemu-290e48e8f1ec975c100520fb697b0ae7300d0fb3.zip
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 <armbru@redhat.com>
Message-Id: <20230510141637.3685080-1-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
[Conflict with commit 3e32dca3f0d resolved]
Diffstat (limited to 'scripts/qapi')
-rw-r--r--scripts/qapi/parser.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 1ff334e6a8..22e7bcc4b1 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -675,8 +675,8 @@ class QAPIDoc:
         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():]