Re: [Qemu-devel] [PATCH v25 03/31] qapi: output def_value_str when query command line options

[Eric Blake]

On 04/10/2014 11:53 AM, Chunyan Liu wrote:
> Change qapi interfaces to output the newly added def_value_str when querying
> command line options.
> 
> Reviewed-by: Eric Blake <address@hidden>
> Signed-off-by: Dong Xu Wang <address@hidden>
> Signed-off-by: Chunyan Liu <address@hidden>
> ---
> changes:
>   * Following Leandro's comment:
>     update description of @default

That's a non-trivial change, since it is user-visible documentation.  I
don't think my Reviewed-by should have carried on this version of the patch.

> 
>  qapi-schema.json   | 6 +++++-
>  qmp-commands.hx    | 2 ++
>  util/qemu-config.c | 4 ++++
>  3 files changed, 11 insertions(+), 1 deletion(-)
> 
> diff --git a/qapi-schema.json b/qapi-schema.json
> index 391356f..cc7c8b6 100644
> --- a/qapi-schema.json
> +++ b/qapi-schema.json
> @@ -4088,12 +4088,16 @@
>  #
>  # @help: #optional human readable text string, not suitable for parsing.
>  #
> +# @default: #optional option's default value - set if option is not
> +#           informed. (since 2.1)

s/informed/provided/

The grammar is awkward, and I think it reads worse in comparison to the
version that I reviewed in v22:

+# @default: #optional string representation of the default used
+#           if the option is omitted. (since 2.0)

Maybe taking the best of both approaches:

@default: #optional string representation of the option's default value;
this default will be used if the option is omitted (since 2.1)

Or, we could go for short and sweet, to match qmp-commands.hx...

> +++ b/qmp-commands.hx
> @@ -2895,6 +2895,8 @@ Each array entry contains the following:
>                or 'size')
>      - "help": human readable description of the parameter
>                (json-string, optional)
> +    - "default": default value string for the parameter
> +                 (json-string, optional)

...by having this in the .json file:

@default: #optional default value string (since 2.0)

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature