From: Eric Blake Date: Wed, 7 Jul 2021 18:41:25 +0000 (-0500) Subject: qemu-img: Reword 'qemu-img map --output=json' docs X-Git-Tag: v6.1.0-rc0~22^2~1 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a275b452c65cea2df598d966a6554f71060d3f3b;p=thirdparty%2Fqemu.git 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 Signed-off-by: Eric Blake Message-Id: <20210707184125.2551140-1-eblake@redhat.com> Reviewed-by: Nir Soffer Reviewed-by: Vladimir Sementsov-Ogievskiy --- diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst index d6300f7ee03..1d8470eada0 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.