diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:06 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:02 +0100 |
| commit | 1d8bda128d2ff1f7e589c90d0ac468b95d260757 (patch) | |
| tree | 697f7ef26b1d5d4fb2fbfc9022e2c4122fe6e237 /qapi/trace.json | |
| parent | aa964b7fdc2b9c6fd0dd530c44563b2a9d891d0f (diff) | |
qapi: The #optional tag is redundant, drop
We traditionally mark optional members #optional in the doc comment.
Before commit 3313b61, this was entirely manual.
Commit 3313b61 added some automation because its qapi2texi.py relied
on #optional to determine whether a member is optional. This is no
longer the case since the previous commit: the only thing qapi2texi.py
still does with #optional is stripping it out. We still reject bogus
qapi-schema.json and six places for qga/qapi-schema.json.
Thus, you can't actually rely on #optional to see whether something is
optional. Yet we still make people add it manually. That's just
busy-work.
Drop the code to check, fix up and strip out #optional, along with all
instances of #optional. To keep it out, add code to reject it, to be
dropped again once the dust settles.
No change to generated documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-18-git-send-email-armbru@redhat.com>
Diffstat (limited to 'qapi/trace.json')
| -rw-r--r-- | qapi/trace.json | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/qapi/trace.json b/qapi/trace.json index 2bfda7ac7c..de6588d9f7 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -48,7 +48,7 @@ # Query the state of events. # # @name: Event name pattern (case-sensitive glob). -# @vcpu: #optional The vCPU to query (any by default; since 2.7). +# @vcpu: The vCPU to query (any by default; since 2.7). # # Returns: a list of @TraceEventInfo for the matching events # @@ -81,8 +81,8 @@ # # @name: Event name pattern (case-sensitive glob). # @enable: Whether to enable tracing. -# @ignore-unavailable: #optional Do not match unavailable events with @name. -# @vcpu: #optional The vCPU to act upon (all by default; since 2.7). +# @ignore-unavailable: Do not match unavailable events with @name. +# @vcpu: The vCPU to act upon (all by default; since 2.7). # # An event's state is modified if: # - its name matches the @name pattern, and |