mbox series

[0/2] qemu-img.texi: Provide more info on some commands’ output

Message ID 20190515075917.24980-1-mreitz@redhat.com
Headers show
Series qemu-img.texi: Provide more info on some commands’ output | expand

Message

Max Reitz May 15, 2019, 7:59 a.m. UTC 
Most qemu-img subcommands that have (optional) JSON output don’t
describe the structure of their JSON output -- but having a fixed,
well-known output structure kind of is the point of having JSON output
at all.  Therefore, patch 1 in this series makes every such command note
which QAPI type their JSON output has in the qemu-img man page.  (The
exception to this is the map subcommand, which does not emit a
QAPI-typed object.  It already has a description of the structure of its
output object, though.)

That should be enough to thoroughly explain the machine-readable output.
But we can also do better for the human-readable output: qemu-img info
emits quite a bit of information, and not all of it is self-explanatory.
In patch 2, I’ve tried to provide some potentially missing explanation.


Max Reitz (2):
  qemu-img.texi: Be specific about JSON object types
  qemu-img.texi: Describe human-readable info output

 qemu-img.texi | 52 ++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 49 insertions(+), 3 deletions(-)

Comments

Kevin Wolf May 20, 2019, 1:32 p.m. UTC | #1 
Am 15.05.2019 um 09:59 hat Max Reitz geschrieben:
> Most qemu-img subcommands that have (optional) JSON output don’t
> describe the structure of their JSON output -- but having a fixed,
> well-known output structure kind of is the point of having JSON output
> at all.  Therefore, patch 1 in this series makes every such command note
> which QAPI type their JSON output has in the qemu-img man page.  (The
> exception to this is the map subcommand, which does not emit a
> QAPI-typed object.  It already has a description of the structure of its
> output object, though.)
> 
> That should be enough to thoroughly explain the machine-readable output.
> But we can also do better for the human-readable output: qemu-img info
> emits quite a bit of information, and not all of it is self-explanatory.
> In patch 2, I’ve tried to provide some potentially missing explanation.

Thanks, applied to the block branch.

Kevin