[PATCH] qemu-img.texi: Describe data_file and data_file_raw

[PATCH] qemu-img.texi: Describe data_file and data_file_raw

[Han Han]

https://bugzilla.redhat.com/show_bug.cgi?id=1763105

Signed-off-by: Han Han <hhan@redhat.com>
---
 qemu-img.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/qemu-img.texi b/qemu-img.texi
index b5156d6316..44596c2d93 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
 
+@item data_file
+File name of data file that is stored in the image and used as a default for
+opening the image. If the option is used, qcow2 file only stores the metadata
+of the image.
+
+@item data_file_raw
+This option requires @option{data_file}. If this option is set to @code{on},
+qemu will always keep the external data file consistent as a standalone
+read-only raw image. Default value is @code{off}.
+
 @end table
 
 @item Other
-- 
2.20.1

Re: [PATCH] qemu-img.texi: Describe data_file and data_file_raw

[Eric Blake]

[cc qemu-block]

On 10/18/19 4:59 AM, Han Han wrote:
> https://bugzilla.redhat.com/show_bug.cgi?id=1763105
> 
> Signed-off-by: Han Han <hhan@redhat.com>
> ---
>   qemu-img.texi | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 

Reviewed-by: Eric Blake <eblake@redhat.com>

> diff --git a/qemu-img.texi b/qemu-img.texi
> index b5156d6316..44596c2d93 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
>   by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
>   the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
>   
> +@item data_file
> +File name of data file that is stored in the image and used as a default for
> +opening the image. If the option is used, qcow2 file only stores the metadata
> +of the image.
> +
> +@item data_file_raw
> +This option requires @option{data_file}. If this option is set to @code{on},
> +qemu will always keep the external data file consistent as a standalone
> +read-only raw image. Default value is @code{off}.
> +
>   @end table
>   
>   @item Other
> 

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

Re: [PATCH] qemu-img.texi: Describe data_file and data_file_raw

[John Snow]

CC qemu-block

On 10/18/19 5:59 AM, Han Han wrote:
> https://bugzilla.redhat.com/show_bug.cgi?id=1763105
> 
> Signed-off-by: Han Han <hhan@redhat.com>
> ---
>  qemu-img.texi | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/qemu-img.texi b/qemu-img.texi
> index b5156d6316..44596c2d93 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
>  by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
>  the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
>  
> +@item data_file
> +File name of data file that is stored in the image and used as a default for
> +opening the image. If the option is used, qcow2 file only stores the metadata
> +of the image.
> +

This is a little unclear, and seems to imply the data file is stored
*IN* the image.

"Optional filename to be used as a data store for this qcow2 file. If
this option is used, the qcow2 file only stores metadata for this image."

> +@item data_file_raw
> +This option requires @option{data_file}. If this option is set to @code{on},
> +qemu will always keep the external data file consistent as a standalone
> +read-only raw image. Default value is @code{off}.
> +
>  @end table
>  
>  @item Other
> 

Re: [PATCH] qemu-img.texi: Describe data_file and data_file_raw

[Han Han]

[-- Attachment #1: Type: text/plain, Size: 1641 bytes --]

On Sat, Oct 19, 2019 at 4:58 AM John Snow <jsnow@redhat.com> wrote:

> CC qemu-block
>
> On 10/18/19 5:59 AM, Han Han wrote:
> > https://bugzilla.redhat.com/show_bug.cgi?id=1763105
> >
> > Signed-off-by: Han Han <hhan@redhat.com>
> > ---
> >  qemu-img.texi | 10 ++++++++++
> >  1 file changed, 10 insertions(+)
> >
> > diff --git a/qemu-img.texi b/qemu-img.texi
> > index b5156d6316..44596c2d93 100644
> > --- a/qemu-img.texi
> > +++ b/qemu-img.texi
> > @@ -763,6 +763,16 @@ file which is COW and has data blocks already, it
> couldn't be changed to NOCOW
> >  by setting @code{nocow=on}. One can issue @code{lsattr filename} to
> check if
> >  the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
> >
> > +@item data_file
> > +File name of data file that is stored in the image and used as a
> default for
> > +opening the image. If the option is used, qcow2 file only stores the
> metadata
> > +of the image.
> > +
>
> This is a little unclear, and seems to imply the data file is stored
> *IN* the image.
>
> "Optional filename to be used as a data store for this qcow2 file. If
> this option is used, the qcow2 file only stores metadata for this image."
>
Thanks for your advice. I will update it in v2.

>
> > +@item data_file_raw
> > +This option requires @option{data_file}. If this option is set to
> @code{on},
> > +qemu will always keep the external data file consistent as a standalone
> > +read-only raw image. Default value is @code{off}.
> > +
> >  @end table
> >
> >  @item Other
> >
>
>

-- 
Best regards,
-----------------------------------
Han Han
Quality Engineer
Redhat.

Email: hhan@redhat.com
Phone: +861065339333

[-- Attachment #2: Type: text/html, Size: 2752 bytes --]