Commit e4def787 authored Oct 24, 2019 by Markus Armbruster

qapi: Polish reporting of bogus member documentation



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>

parent b3cdff10

scripts/qapi/parser.py

+4 −2

Original line number	Diff line number	Diff line
		@@ -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"))

tests/qapi-schema/doc-bad-alternate-member.err

+1 −1

Original line number	Diff line number	Diff line
		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

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

+1 −1

Original line number	Diff line number	Diff line
		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

tests/qapi-schema/doc-bad-command-arg.err

+1 −1

Original line number	Diff line number	Diff line
		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

tests/qapi-schema/doc-bad-enum-member.err

+1 −1

Original line number	Diff line number	Diff line
		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