diff options
| author | Markus Armbruster <armbru@redhat.com> | 2019-10-24 13:02:36 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2019-10-29 07:35:16 +0100 |
| commit | e4def7875520aef0643e83698e397abe229a8953 (patch) | |
| tree | ad03c6caae370252b8c920e95e399f9222f68b6d | |
| parent | b3cdff10e5e82ba7b99c59ab3089883f6bb85ed8 (diff) | |
| download | qemu-e4def7875520aef0643e83698e397abe229a8953.zip qemu-e4def7875520aef0643e83698e397abe229a8953.tar.gz qemu-e4def7875520aef0643e83698e397abe229a8953.tar.bz2 | |
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>
| -rw-r--r-- | scripts/qapi/parser.py | 6 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-alternate-member.err | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-boxed-command-arg.err | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-command-arg.err | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-enum-member.err | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-event-arg.err | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-union-member.err | 2 |
7 files changed, 10 insertions, 8 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index e800876..6c45a00 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -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")) diff --git a/tests/qapi-schema/doc-bad-alternate-member.err b/tests/qapi-schema/doc-bad-alternate-member.err index a1c282f..d7286bb 100644 --- a/tests/qapi-schema/doc-bad-alternate-member.err +++ b/tests/qapi-schema/doc-bad-alternate-member.err @@ -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 diff --git a/tests/qapi-schema/doc-bad-boxed-command-arg.err b/tests/qapi-schema/doc-bad-boxed-command-arg.err index e1101b1..7137af3 100644 --- a/tests/qapi-schema/doc-bad-boxed-command-arg.err +++ b/tests/qapi-schema/doc-bad-boxed-command-arg.err @@ -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 diff --git a/tests/qapi-schema/doc-bad-command-arg.err b/tests/qapi-schema/doc-bad-command-arg.err index 153ea03..18ed076 100644 --- a/tests/qapi-schema/doc-bad-command-arg.err +++ b/tests/qapi-schema/doc-bad-command-arg.err @@ -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 diff --git a/tests/qapi-schema/doc-bad-enum-member.err b/tests/qapi-schema/doc-bad-enum-member.err index dfa1e78..7efeb47 100644 --- a/tests/qapi-schema/doc-bad-enum-member.err +++ b/tests/qapi-schema/doc-bad-enum-member.err @@ -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 diff --git a/tests/qapi-schema/doc-bad-event-arg.err b/tests/qapi-schema/doc-bad-event-arg.err index 114ff4a..d13cacf 100644 --- a/tests/qapi-schema/doc-bad-event-arg.err +++ b/tests/qapi-schema/doc-bad-event-arg.err @@ -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 diff --git a/tests/qapi-schema/doc-bad-union-member.err b/tests/qapi-schema/doc-bad-union-member.err index 8b9d36e..6dd2726 100644 --- a/tests/qapi-schema/doc-bad-union-member.err +++ b/tests/qapi-schema/doc-bad-union-member.err @@ -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 |