OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qapi: Polish reporting of bogus member documentation

Browse Source 
Improve error messages from

    the following documented members are not in the declaration: a
    the following documented members are not in the declaration: aa, bb

to the more concise

    documented member 'a' does not exist
    documented members 'aa', 'bb' do not exist

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191024110237.30963-19-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2019-10-24 13:02:36 +02:00
parent b3cdff10e5
commit e4def78755
7 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
scripts/qapi/parser.py
View File

@ -566,5 +566,7 @@ class QAPIDoc(object):
if bogus:
raise QAPISemError(
self.info,
"the following documented members are not in "
"the declaration: %s" % ", ".join(bogus))
"documented member%s '%s' %s not exist"
% ("s" if len(bogus) > 1 else "",
"', '".join(bogus),
"do" if len(bogus) > 1 else "does"))

2
tests/qapi-schema/doc-bad-alternate-member.err
View File

@ -1 +1 @@
doc-bad-alternate-member.json:3: the following documented members are not in the declaration: aa, bb
doc-bad-alternate-member.json:3: documented members 'aa', 'bb' do not exist

2
tests/qapi-schema/doc-bad-boxed-command-arg.err
View File

@ -1 +1 @@
doc-bad-boxed-command-arg.json:9: the following documented members are not in the declaration: a
doc-bad-boxed-command-arg.json:9: documented member 'a' does not exist

2
tests/qapi-schema/doc-bad-command-arg.err
View File

@ -1 +1 @@
doc-bad-command-arg.json:3: the following documented members are not in the declaration: b
doc-bad-command-arg.json:3: documented member 'b' does not exist

2
tests/qapi-schema/doc-bad-enum-member.err
View File

@ -1 +1 @@
doc-bad-enum-member.json:3: the following documented members are not in the declaration: a
doc-bad-enum-member.json:3: documented member 'a' does not exist

2
tests/qapi-schema/doc-bad-event-arg.err
View File

@ -1 +1 @@
doc-bad-event-arg.json:3: the following documented members are not in the declaration: a
doc-bad-event-arg.json:3: documented member 'a' does not exist

2
tests/qapi-schema/doc-bad-union-member.err
View File

@ -1 +1 @@
doc-bad-union-member.json:3: the following documented members are not in the declaration: a, b
doc-bad-union-member.json:3: documented members 'a', 'b' do not exist