aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2021-07-07 13:41:25 -0500
committerEric Blake <eblake@redhat.com>2021-07-12 11:11:48 -0500
commita275b452c65cea2df598d966a6554f71060d3f3b (patch)
treebf2c48167565d992f4666bf995a80e334aa698d1
parent8417e1378cadb8928c24755a95ff267def53922f (diff)
qemu-img: Reword 'qemu-img map --output=json' docs
Reword the paragraphs to list the JSON key first, rather than in the middle of prose. Suggested-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com> Signed-off-by: Eric Blake <eblake@redhat.com> Message-Id: <20210707184125.2551140-1-eblake@redhat.com> Reviewed-by: Nir Soffer <nsoffer@redhat.com> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
-rw-r--r--docs/tools/qemu-img.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index d6300f7ee0..1d8470eada 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -593,16 +593,16 @@ Command description:
the ``start``, ``length``, ``offset`` fields;
it will also include other more specific information:
- - whether the sectors contain actual data or not (boolean field ``data``;
- if false, the sectors are either unallocated or stored as optimized
- all-zero clusters);
- - whether the data is known to read as zero (boolean field ``zero``);
- - whether the data is actually present (boolean field ``present``);
- if false, rebasing the backing chain onto a deeper file would pick
- up data from the deeper file;
- - in order to make the output shorter, the target file is expressed as
- a ``depth``; for example, a depth of 2 refers to the backing file
- of the backing file of *FILENAME*.
+ - boolean field ``data``: true if the sectors contain actual data,
+ false if the sectors are either unallocated or stored as optimized
+ all-zero clusters
+ - boolean field ``zero``: true if the data is known to read as zero
+ - boolean field ``present``: true if the data belongs to the backing
+ chain, false if rebasing the backing chain onto a deeper file
+ would pick up data from the deeper file;
+ - integer field ``depth``: the depth within the backing chain at
+ which the data was resolved; for example, a depth of 2 refers to
+ the backing file of the backing file of *FILENAME*.
In JSON format, the ``offset`` field is optional; it is absent in
cases where ``human`` format would omit the entry or exit with an error.