Re: [PATCH 2/2] qcow2: dump QCOW2 metadata

[Eric Blake <eblake@redhat.com>]

On 1/13/20 11:02 AM, Andrey Shinkevich wrote:

>>>>> +++ b/qemu-img.texi
>>>>> @@ -230,7 +230,7 @@ specified as well.
>>>>>     For write tests, by default a buffer filled with zeros is written.
>>>>> This can be
>>>>>     overridden with a pattern byte specified by @var{pattern}.
>>>>> -@item check [--object @var{objectdef}] [--image-opts] [-q] [-f
>>>>> @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T
>>>>> @var{src_cache}] [-U] @var{filename}
>>>>> +@item check [--object @var{objectdef}] [--image-opts] [-M] [-q] [-f
>>>>> @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T
>>>>> @var{src_cache}] [-U] @var{filename}
>>>>
>>>> This mentions that -M is valid, but has no further documentation on what
>>>> -M means.  Without that, it's anyone's guess.
>>>>
>>>
>>> Thank you Eric, I really missed to supply a comment for the new option
>>> here and am going to put it below. Should I mention that option in
>>> qapi/block-core.json file also with this patch of the series?
>>
>> Mentioning that the qapi type exists to facilitate a qemu-img option
>> might not hurt. But more important is that the qemu-img documentation
>> mentions what -M does; that documentation can point to the qapi docs for
>> how the output will be structured when --output=json is in effect.
>>
> 
> Would you please specify the qemu-img and qapi documentation files to
> modify? Thank you.

I'm thinking that qemu-img.texi can simply mention something like "see 
type XYZ in the QAPI docs for how the JSON output will be formatted", 
and then your QAPI documentation already added in patch 1/2 is then 
sufficient to cover the details of what -M exposes here.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org