OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qemu-img: Reword 'qemu-img map --output=json' docs

Browse Source 
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>
This commit is contained in:
Eric Blake 2021-07-07 13:41:25 -05:00
parent 8417e1378c
commit a275b452c6
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/tools/qemu-img.rst
View File

@ -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.