xemu/docs/interop
Alberto Garcia 156b46ded3 specs/qcow2: Fix documentation of the compressed cluster descriptor
This patch fixes several mistakes in the documentation of the
compressed cluster descriptor:

1) the documentation claims that the cluster descriptor contains the
   number of sectors used to store the compressed data, but what it
   actually contains is the number of sectors *minus one* or, in other
   words, the number of additional sectors after the first one.

2) the width of the fields is incorrectly specified. The number of bits
   used by each field is

      x = 62 - (cluster_bits - 8)   for the offset field
      y = (cluster_bits - 8)        for the size field

   So the offset field's location is [0, x-1], not [0, x] as stated.

3) the size field does not contain the size of the compressed data,
   but rather the number of sectors where that data is stored. The
   compressed data starts at the exact point specified in the offset
   field and ends when there's enough data to produce a cluster of
   decompressed data. Both points can be in the middle of a sector,
   allowing several compressed clusters to be stored next to one
   another, sharing sectors if necessary.

Cc: qemu-stable@nongnu.org
Signed-off-by: Alberto Garcia <berto@igalia.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-03-02 18:39:07 +01:00
..
bitmaps.rst bitmaps.md: Convert to rST; move it into 'interop' dir 2017-07-18 00:11:01 -04:00
live-block-operations.rst QAPI & interop: Clarify events emitted by 'block-job-cancel' 2017-11-27 14:59:35 +01:00
parallels.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
pr-helper.rst scsi: build qemu-pr-helper 2017-09-22 21:07:24 +02:00
prl-xml.txt docs/interop/prl-xml: description of Parallels Disk format 2018-01-22 14:02:33 +00:00
qcow2.txt specs/qcow2: Fix documentation of the compressed cluster descriptor 2018-03-02 18:39:07 +01:00
qed_spec.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qemu-ga-ref.texi docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qemu-qmp-ref.texi docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qmp-intro.txt Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
qmp-spec.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
vhost-user.txt cryptodev-vhost-user: add crypto session handler 2018-03-01 18:26:17 +02:00
vnc-ledstate-Pseudo-encoding.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00