[02/21] specs/qcow2: do not use wording 'bitmap header'
diff mbox

Message ID 1478715476-132280-3-git-send-email-vsementsov@virtuozzo.com
State New
Headers show

Commit Message

Vladimir Sementsov-Ogievskiy Nov. 9, 2016, 6:17 p.m. UTC
A bitmap directory entry is sometimes called a 'bitmap header'. This
patch leaves only one name - 'bitmap directory entry'. The name 'bitmap
header' creates misunderstandings with 'qcow2 header' and 'qcow2 bitmap
header extension' (which is extension of qcow2 header)

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
 docs/specs/qcow2.txt | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

John Snow Nov. 14, 2016, 8:08 p.m. UTC | #1
On 11/09/2016 01:17 PM, Vladimir Sementsov-Ogievskiy wrote:
> A bitmap directory entry is sometimes called a 'bitmap header'. This
> patch leaves only one name - 'bitmap directory entry'. The name 'bitmap
> header' creates misunderstandings with 'qcow2 header' and 'qcow2 bitmap
> header extension' (which is extension of qcow2 header)
>
> Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
> Reviewed-by: Eric Blake <eblake@redhat.com>
> ---
>  docs/specs/qcow2.txt | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/docs/specs/qcow2.txt b/docs/specs/qcow2.txt
> index dda53dd..8874e8c 100644
> --- a/docs/specs/qcow2.txt
> +++ b/docs/specs/qcow2.txt
> @@ -201,7 +201,7 @@ The fields of the bitmaps extension are:
>
>            8 - 15:  bitmap_directory_size
>                     Size of the bitmap directory in bytes. It is the cumulative
> -                   size of all (nb_bitmaps) bitmap headers.
> +                   size of all (nb_bitmaps) bitmap directory entries.
>
>           16 - 23:  bitmap_directory_offset
>                     Offset into the image file at which the bitmap directory
> @@ -426,8 +426,7 @@ Each bitmap saved in the image is described in a bitmap directory entry. The
>  bitmap directory is a contiguous area in the image file, whose starting offset
>  and length are given by the header extension fields bitmap_directory_offset and
>  bitmap_directory_size. The entries of the bitmap directory have variable
> -length, depending on the lengths of the bitmap name and extra data. These
> -entries are also called bitmap headers.
> +length, depending on the lengths of the bitmap name and extra data.
>
>  Structure of a bitmap directory entry:
>
>

Great improvement.

Reviewed-by: John Snow <jsnow@redhat.com>

Patch
diff mbox

diff --git a/docs/specs/qcow2.txt b/docs/specs/qcow2.txt
index dda53dd..8874e8c 100644
--- a/docs/specs/qcow2.txt
+++ b/docs/specs/qcow2.txt
@@ -201,7 +201,7 @@  The fields of the bitmaps extension are:
 
           8 - 15:  bitmap_directory_size
                    Size of the bitmap directory in bytes. It is the cumulative
-                   size of all (nb_bitmaps) bitmap headers.
+                   size of all (nb_bitmaps) bitmap directory entries.
 
          16 - 23:  bitmap_directory_offset
                    Offset into the image file at which the bitmap directory
@@ -426,8 +426,7 @@  Each bitmap saved in the image is described in a bitmap directory entry. The
 bitmap directory is a contiguous area in the image file, whose starting offset
 and length are given by the header extension fields bitmap_directory_offset and
 bitmap_directory_size. The entries of the bitmap directory have variable
-length, depending on the lengths of the bitmap name and extra data. These
-entries are also called bitmap headers.
+length, depending on the lengths of the bitmap name and extra data.
 
 Structure of a bitmap directory entry: