david.venhoff/QEMU-Nyx-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qemu-img.texi: Be specific about JSON object types

Browse Source 
Just writing that --output=json outputs JSON information does not really
help; we should also make a note of what QAPI type the result object
has.  (The map subcommand does not emit a QAPI-typed object, but its
section already describes the object structure well enough.)

Signed-off-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
Max Reitz 2019-05-15 09:59:16 +02:00 committed by Kevin Wolf
parent 2fab30c80b
commit 987402c5c2
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
qemu-img.texi
View File

@ -230,6 +230,7 @@ overridden with a pattern byte specified by @var{pattern}.
Perform a consistency check on the disk image @var{filename}. The command can Perform a consistency check on the disk image @var{filename}. The command can
output in the format @var{ofmt} which is either @code{human} or @code{json}. output in the format @var{ofmt} which is either @code{human} or @code{json}.
The JSON output is an object of QAPI type @code{ImageCheck}.
If @code{-r} is specified, qemu-img tries to repair any inconsistencies found If @code{-r} is specified, qemu-img tries to repair any inconsistencies found
during the check. @code{-r leaks} repairs only cluster leaks, whereas during the check. @code{-r leaks} repairs only cluster leaks, whereas
@ -406,8 +407,7 @@ The size syntax is similar to dd(1)'s size syntax.
Give information about the disk image @var{filename}. Use it in Give information about the disk image @var{filename}. Use it in
particular to know the size reserved on disk which can be different particular to know the size reserved on disk which can be different
from the displayed size. If VM snapshots are stored in the disk image, from the displayed size. If VM snapshots are stored in the disk image,
they are displayed too. The command can output in the format @var{ofmt} they are displayed too.
which is either @code{human} or @code{json}.
If a disk image has a backing file chain, information about each disk image in If a disk image has a backing file chain, information about each disk image in
the chain can be recursively enumerated by using the option @code{--backing-chain}. the chain can be recursively enumerated by using the option @code{--backing-chain}.
@ -424,6 +424,10 @@ To enumerate information about each disk image in the above chain, starting from
qemu-img info --backing-chain snap2.qcow2 qemu-img info --backing-chain snap2.qcow2
@end example @end example
The command can output in the format @var{ofmt} which is either @code{human} or
@code{json}. The JSON output is an object of QAPI type @code{ImageInfo}; with
@code{--backing-chain}, it is an array of @code{ImageInfo} objects.
@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename} @item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename}
Dump the metadata of image @var{filename} and its backing file chain. Dump the metadata of image @var{filename} and its backing file chain.
@ -485,7 +489,8 @@ Calculate the file size required for a new image. This information can be used
to size logical volumes or SAN LUNs appropriately for the image that will be to size logical volumes or SAN LUNs appropriately for the image that will be
placed in them. The values reported are guaranteed to be large enough to fit placed in them. The values reported are guaranteed to be large enough to fit
the image. The command can output in the format @var{ofmt} which is either the image. The command can output in the format @var{ofmt} which is either
@code{human} or @code{json}. @code{human} or @code{json}. The JSON output is an object of QAPI type
@code{BlockMeasureInfo}.
If the size @var{N} is given then act as if creating a new empty image file If the size @var{N} is given then act as if creating a new empty image file
using @command{qemu-img create}. If @var{filename} is given then act as if using @command{qemu-img create}. If @var{filename} is given then act as if