From: Eric Blake <eblake@redhat.com>
To: qemu-devel@nongnu.org
Cc: kwolf@redhat.com, vsementsov@virtuozzo.com,
qemu-block@nongnu.org, armbru@redhat.com, mreitz@redhat.com,
nsoffer@redhat.com
Subject: [PATCH v3 3/2] qemu-img: Reword 'qemu-img map --output=json' docs
Date: Wed, 7 Jul 2021 13:41:25 -0500 [thread overview]
Message-ID: <20210707184125.2551140-1-eblake@redhat.com> (raw)
In-Reply-To: <20210701190655.2131223-1-eblake@redhat.com>
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>
---
docs/tools/qemu-img.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index d6300f7ee03d..1d8470eada0e 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.
--
2.31.1
next prev parent reply other threads:[~2021-07-07 18:42 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-01 19:06 [PATCH v3 0/2] qemu-img: Make unallocated part of backing chain obvious in map Eric Blake
2021-07-01 19:06 ` [PATCH v3 1/2] iotests: Improve and rename test 309 to nbd-qemu-allocation Eric Blake
2021-07-01 19:06 ` [PATCH v3 2/2] qemu-img: Make unallocated part of backing chain obvious in map Eric Blake
2021-07-03 7:25 ` Vladimir Sementsov-Ogievskiy
2021-07-07 15:10 ` Eric Blake
2021-07-07 18:41 ` Eric Blake [this message]
2021-07-07 20:39 ` [PATCH v3 3/2] qemu-img: Reword 'qemu-img map --output=json' docs Nir Soffer
2021-07-08 8:00 ` Vladimir Sementsov-Ogievskiy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210707184125.2551140-1-eblake@redhat.com \
--to=eblake@redhat.com \
--cc=armbru@redhat.com \
--cc=kwolf@redhat.com \
--cc=mreitz@redhat.com \
--cc=nsoffer@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@virtuozzo.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).