mirror of
https://github.com/izzy2lost/xemu.git
synced 2026-07-06 00:20:22 -07:00
qapi: The #optional tag is redundant, drop
We traditionally mark optional members #optional in the doc comment. Before commit3313b61, this was entirely manual. Commit3313b61added 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>
This commit is contained in:
@@ -131,10 +131,8 @@ and optional tagged sections.
|
||||
|
||||
FIXME: the parser accepts these things in almost any order.
|
||||
|
||||
Optional arguments / members are tagged with the phrase '#optional',
|
||||
often with their default value; and extensions added after the
|
||||
expression was first released are also given a '(since x.y.z)'
|
||||
comment.
|
||||
Extensions added after the expression was first released carry a
|
||||
'(since x.y.z)' comment.
|
||||
|
||||
A tagged section starts with one of the following words:
|
||||
"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:".
|
||||
@@ -150,10 +148,10 @@ For example:
|
||||
#
|
||||
# Statistics of a virtual block device or a block backing device.
|
||||
#
|
||||
# @device: #optional If the stats are for a virtual block device, the name
|
||||
# @device: If the stats are for a virtual block device, the name
|
||||
# corresponding to the virtual block device.
|
||||
#
|
||||
# @node-name: #optional The node name of the device. (since 2.3)
|
||||
# @node-name: The node name of the device. (since 2.3)
|
||||
#
|
||||
# ... more members ...
|
||||
#
|
||||
@@ -168,7 +166,7 @@ For example:
|
||||
#
|
||||
# Query the @BlockStats for all virtual block devices.
|
||||
#
|
||||
# @query-nodes: #optional If true, the command will query all the
|
||||
# @query-nodes: If true, the command will query all the
|
||||
# block nodes ... explain, explain ... (since 2.3)
|
||||
#
|
||||
# Returns: A list of @BlockStats for each virtual block devices.
|
||||
|
||||
@@ -252,7 +252,7 @@ here goes "hello-world"'s new entry for the qapi-schema.json file:
|
||||
#
|
||||
# Print a client provided string to the standard output stream.
|
||||
#
|
||||
# @message: #optional string to be printed
|
||||
# @message: string to be printed
|
||||
#
|
||||
# Returns: Nothing on success.
|
||||
#
|
||||
@@ -358,7 +358,7 @@ The best way to return that data is to create a new QAPI type, as shown below:
|
||||
#
|
||||
# @clock-name: The alarm clock method's name.
|
||||
#
|
||||
# @next-deadline: #optional The time (in nanoseconds) the next alarm will fire.
|
||||
# @next-deadline: The time (in nanoseconds) the next alarm will fire.
|
||||
#
|
||||
# Since: 1.0
|
||||
##
|
||||
|
||||
Reference in New Issue
Block a user