Re: [Qemu-devel] [PATCH v9 13/13] dump: add 'query-dump-guest-memory-capability' command

[Eric Blake]

On 02/11/2014 08:13 PM, Qiao Nuohan wrote:
> 'query-dump-guest-memory-capability' is used to query the available
> formats of
> 'dump-guest-memory'. The output of the command will be like:
> 
> -> { "execute": "query-dump-guest-memory-capability" }
> <- { "return": { "formats":
>                     ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
> 
> Signed-off-by: Qiao Nuohan <address@hidden>
> ---
>  dump.c           |   33 +++++++++++++++++++++++++++++++++
>  qapi-schema.json |    9 +++++++++
>  qmp-commands.hx  |   23 +++++++++++++++++++++++
>  3 files changed, 65 insertions(+), 0 deletions(-)


> +++ b/qapi-schema.json
> @@ -2783,6 +2783,15 @@
>              '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
> 
>  ##
> +# Since: 2.0

A bit sparse on the documentation; at a minimum, you want a line:

# @query-dump-guest-memory-capability:

prior to the Since designation (look at @query-name for an example).


> +
> +SQMP
> +query-dump-guest-memory-capability
> +----------
> +
> +Show available format of 'dump-guest-memory'

s/format of/formats for/

> +
> +Example:
> +
> +-> { "execute": "query-dump-guest-memory-capability" }
> +<- { "return": { "formats":
> +                    ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
> +
> +Note: This is a light-weight introspection to let management know the
> available
> +      formats of dump-guest-memory.

This note feels a bit redundant with the earlier summary; I'm okay if
you leave it in, but I also don't mind if you drop it.

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

signature.asc
Description: OpenPGP digital signature