diff options
author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:26 +0100 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:04 +0100 |
commit | 816a57cd6ebb6fe820766ac12478a56a5fa33d52 (patch) | |
tree | 1f6d4f1946a0c1dcef1fb56d3ae4446426ad2697 | |
parent | f641d06ad63773ae524fb073b2f8639e1db1462c (diff) | |
download | qemu-816a57cd6ebb6fe820766ac12478a56a5fa33d52.zip qemu-816a57cd6ebb6fe820766ac12478a56a5fa33d52.tar.gz qemu-816a57cd6ebb6fe820766ac12478a56a5fa33d52.tar.bz2 |
qapi: Fix detection of bogus member documentation
check_definition_doc() checks for member documentation without a
matching member. It laboriously second-guesses what members
QAPISchema._def_exprs() will create. That's a stupid game.
Move the check into QAPISchema.check(), where the members are known.
Delegate the actual checking to new QAPIDoc.check().
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-38-git-send-email-armbru@redhat.com>
-rw-r--r-- | scripts/qapi.py | 38 | ||||
-rw-r--r-- | tests/qapi-schema/doc-bad-union-member.err | 1 | ||||
-rw-r--r-- | tests/qapi-schema/doc-bad-union-member.exit | 2 | ||||
-rw-r--r-- | tests/qapi-schema/doc-bad-union-member.out | 11 |
4 files changed, 15 insertions, 37 deletions
diff --git a/scripts/qapi.py b/scripts/qapi.py index 648355e..ca9926b 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -249,6 +249,15 @@ class QAPIDoc(object): self.args[member.name] = QAPIDoc.ArgSection(member.name) self.args[member.name].connect(member) + def check(self): + bogus = [name for name, section in self.args.iteritems() + if not section.member] + if bogus: + raise QAPISemError( + self.info, + "The following documented members are not in " + "the declaration: %s" % ", ".join(bogus)) + class QAPISchemaParser(object): @@ -995,34 +1004,9 @@ def check_exprs(exprs): def check_definition_doc(doc, expr, info): - for i in ('enum', 'union', 'alternate', 'struct', 'command', 'event'): - if i in expr: - meta = i - break - if doc.has_section('Returns') and 'command' not in expr: raise QAPISemError(info, "'Returns:' is only valid for commands") - if meta == 'union': - args = expr.get('base', []) - else: - args = expr.get('data', []) - if isinstance(args, str): - return - if isinstance(args, dict): - args = args.keys() - assert isinstance(args, list) - - if (meta == 'alternate' - or (meta == 'union' and not expr.get('discriminator'))): - args.append('type') - - doc_args = set(doc.args.keys()) - args = set([name.strip('*') for name in args]) - if not doc_args.issubset(args): - raise QAPISemError(info, "The following documented members are not in " - "the declaration: %s" % ', '.join(doc_args - args)) - def check_docs(docs): for doc in docs: @@ -1268,6 +1252,8 @@ class QAPISchemaObjectType(QAPISchemaType): self.variants.check(schema, seen) assert self.variants.tag_member in self.members self.variants.check_clash(schema, self.info, seen) + if self.doc: + self.doc.check() # Check that the members of this type do not cause duplicate JSON members, # and update seen to track the members seen so far. Report any errors @@ -1437,6 +1423,8 @@ class QAPISchemaAlternateType(QAPISchemaType): v.check_clash(self.info, seen) if self.doc: self.doc.connect_member(v) + if self.doc: + self.doc.check() def c_type(self): return c_name(self.name) + pointer_suffix diff --git a/tests/qapi-schema/doc-bad-union-member.err b/tests/qapi-schema/doc-bad-union-member.err index e69de29..4b016df 100644 --- a/tests/qapi-schema/doc-bad-union-member.err +++ b/tests/qapi-schema/doc-bad-union-member.err @@ -0,0 +1 @@ +tests/qapi-schema/doc-bad-union-member.json:3: The following documented members are not in the declaration: a, b diff --git a/tests/qapi-schema/doc-bad-union-member.exit b/tests/qapi-schema/doc-bad-union-member.exit index 573541a..d00491f 100644 --- a/tests/qapi-schema/doc-bad-union-member.exit +++ b/tests/qapi-schema/doc-bad-union-member.exit @@ -1 +1 @@ -0 +1 diff --git a/tests/qapi-schema/doc-bad-union-member.out b/tests/qapi-schema/doc-bad-union-member.out index 2576ecd..e69de29 100644 --- a/tests/qapi-schema/doc-bad-union-member.out +++ b/tests/qapi-schema/doc-bad-union-member.out @@ -1,11 +0,0 @@ -object Base - member type: T optional=False -object Empty -object Frob - base Base - tag type - case nothing: Empty -enum QType ['none', 'qnull', 'qint', 'qstring', 'qdict', 'qlist', 'qfloat', 'qbool'] - prefix QTYPE -enum T ['nothing'] -object q_empty |