[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 19/24] qemu-img.texi: Be specific about JSON object t
From: |
Kevin Wolf |
Subject: |
[Qemu-devel] [PULL 19/24] qemu-img.texi: Be specific about JSON object types |
Date: |
Mon, 20 May 2019 18:14:48 +0200 |
From: Max Reitz <address@hidden>
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 <address@hidden>
Signed-off-by: Kevin Wolf <address@hidden>
---
qemu-img.texi | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/qemu-img.texi b/qemu-img.texi
index 724f244ba1..39562317ee 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -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
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
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
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,
-they are displayed too. The command can output in the format @var{ofmt}
-which is either @code{human} or @code{json}.
+they are displayed too.
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}.
@@ -424,6 +424,10 @@ To enumerate information about each disk image in the
above chain, starting from
qemu-img info --backing-chain snap2.qcow2
@end example
+The command can output in the format @var{ofmt} which is either @code{human} or
address@hidden The JSON output is an object of QAPI type @code{ImageInfo}; with
address@hidden, it is an array of @code{ImageInfo} objects.
+
@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}]
address@hidden [-U] @var{filename}
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
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
address@hidden or @code{json}.
address@hidden or @code{json}. The JSON output is an object of QAPI type
address@hidden
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
--
2.20.1
- [Qemu-devel] [PULL 10/24] block: Propagate AioContext change to parents, (continued)
- [Qemu-devel] [PULL 10/24] block: Propagate AioContext change to parents, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 08/24] block: Make bdrv_attach/detach_aio_context() static, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 16/24] test-block-iothread: Test AioContext propagation for block jobs, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 15/24] blockjob: Remove AioContext notifiers, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 14/24] blockjob: Propagate AioContext change to all job nodes, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 17/24] block/file-posix: Unaligned O_DIRECT block-status, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 21/24] block: Improve "Block node is read-only" message, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 20/24] qemu-img.texi: Describe human-readable info output, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 23/24] iotests.py: Fix VM.run_job, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 22/24] iotests.py: Let assert_qmp() accept an array, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 19/24] qemu-img.texi: Be specific about JSON object types,
Kevin Wolf <=
- [Qemu-devel] [PULL 18/24] iotests: Test unaligned raw images with O_DIRECT, Kevin Wolf, 2019/05/20
- [Qemu-devel] [PULL 24/24] iotests: Make 245 faster and more reliable, Kevin Wolf, 2019/05/20
- Re: [Qemu-devel] [PULL 00/24] Block layer patches, Peter Maydell, 2019/05/20