diff options
| author | Markus Armbruster <armbru@redhat.com> | 2019-10-24 13:02:29 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2019-10-29 07:35:16 +0100 |
| commit | bf83f04e13063bb723fb8b9df789a3613c6d0ceb (patch) | |
| tree | 67a2fe4a8810cef47a08cd141e3fffe5f0fed463 /qapi/net.json | |
| parent | 7faefad184201b10c2db4270b2bb93e2a5e9552b (diff) | |
| download | qemu-bf83f04e13063bb723fb8b9df789a3613c6d0ceb.zip qemu-bf83f04e13063bb723fb8b9df789a3613c6d0ceb.tar.gz qemu-bf83f04e13063bb723fb8b9df789a3613c6d0ceb.tar.bz2 | |
qapi: Fix doc comment checking for commands and events
When a command's 'data' is an object, its doc comment describes the
arguments defined there. When 'data' names a type, the doc comment
does not describe arguments. Instead, the doc generator inserts a
pointer to the named type.
An event's doc comment works the same.
We don't actually check doc comments for commands and events.
Instead, QAPISchema._def_command() forwards the doc comment to the
implicit argument type, where it gets checked. Works because the
check only cares for the implicit argument type's members.
Not only is this needlessly hard to understand, it actually falls
apart in two cases:
* When 'data' is empty, there is nothing to forward to, and the doc
comment remains unchecked. Demonstrated by test doc-bad-event-arg.
* When 'data' names a type, we can't forward, as the type has its own
doc comment. The command or event's doc comment remains unchecked.
Demonstrated by test doc-bad-boxed-command-arg.
The forwarding goes back to commit 069fb5b250 "qapi: Prepare for
requiring more complete documentation", put to use in commit
816a57cd6e "qapi: Fix detection of bogus member documentation". That
fix was incomplete.
To fix this, make QAPISchemaCommand and QAPISchemaEvent check doc
comments, and drop the forwarding of doc comments to implicit argument
types.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191024110237.30963-12-armbru@redhat.com>
Diffstat (limited to 'qapi/net.json')
| -rw-r--r-- | qapi/net.json | 2 |
1 files changed, 0 insertions, 2 deletions
diff --git a/qapi/net.json b/qapi/net.json index 728990f..4c96137 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -723,8 +723,6 @@ # Trigger generation of broadcast RARP frames to update network switches. # This can be useful when network bonds fail-over the active slave. # -# @params: AnnounceParameters giving timing and repetition count of announce -# # Example: # # -> { "execute": "announce-self", |