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/introspect.json | |
parent | aa964b7fdc2b9c6fd0dd530c44563b2a9d891d0f (diff) | |
download | qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.zip qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.tar.gz qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.tar.bz2 |
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/introspect.json')
-rw-r--r-- | qapi/introspect.json | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/qapi/introspect.json b/qapi/introspect.json index f6adc43..1dbaef5 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -163,10 +163,10 @@ # # @members: the object type's (non-variant) members, in no particular order. # -# @tag: #optional the name of the member serving as type tag. +# @tag: the name of the member serving as type tag. # An element of @members with this name must exist. # -# @variants: #optional variant members, i.e. additional members that +# @variants: variant members, i.e. additional members that # depend on the type tag's value. Present exactly when # @tag is present. The variants are in no particular order, # and may even differ from the order of the values of the @@ -190,7 +190,7 @@ # # @type: the name of the member's type. # -# @default: #optional default when used as command parameter. +# @default: default when used as command parameter. # If absent, the parameter is mandatory. # If present, the value must be null. The parameter is # optional, and behavior when it's missing is not specified |