diff mbox

[2/2] qemu-img: fix rebase src_cache option documentation

Message ID 1409584287-21844-3-git-send-email-stefanha@redhat.com
State New
Headers show

Commit Message

Stefan Hajnoczi Sept. 1, 2014, 3:11 p.m. UTC
The src_cache option (-T) specifies the cache mode for backing files.
It applies both the image's old backing file as well as the new backing
file:

  ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
                  old_backing_drv, &local_err);
  if (ret) {
      ...
  }
  if (out_baseimg[0]) {
      bs_new_backing = bdrv_new("new_backing", &error_abort);
      ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
                      new_backing_drv, &local_err);
      if (ret) {
          ...
      }
  }

The documentation only mentions the new backing file but it really
applies to both.

Suggested-by: Jeff Nelson <jenelson@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 qemu-img.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Fam Zheng Sept. 2, 2014, 2:52 a.m. UTC | #1
On Mon, 09/01 16:11, Stefan Hajnoczi wrote:
> The src_cache option (-T) specifies the cache mode for backing files.
> It applies both the image's old backing file as well as the new backing
> file:
> 
>   ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
>                   old_backing_drv, &local_err);
>   if (ret) {
>       ...
>   }
>   if (out_baseimg[0]) {
>       bs_new_backing = bdrv_new("new_backing", &error_abort);
>       ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
>                       new_backing_drv, &local_err);
>       if (ret) {
>           ...
>       }
>   }
> 
> The documentation only mentions the new backing file but it really
> applies to both.
> 
> Suggested-by: Jeff Nelson <jenelson@redhat.com>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>  qemu-img.texi | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qemu-img.texi b/qemu-img.texi
> index 4380d56..7c2df14 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -341,7 +341,7 @@ string), then the image is rebased onto no backing file (i.e. it will exist
>  independently of any backing file).
>  
>  @var{cache} specifies the cache mode to be used for @var{filename}, whereas
> -@var{src_cache} specifies the cache mode for reading the new backing file.
> +@var{src_cache} specifies the cache mode for reading backing file files.

Is "backing file files" intended, why not just "backing files"? :)

Fam

>  
>  There are two different modes in which @code{rebase} can operate:
>  @table @option
> -- 
> 1.9.3
> 
>
Stefan Hajnoczi Sept. 2, 2014, 10:01 a.m. UTC | #2
On Tue, Sep 02, 2014 at 10:52:53AM +0800, Fam Zheng wrote:
> On Mon, 09/01 16:11, Stefan Hajnoczi wrote:
> > The src_cache option (-T) specifies the cache mode for backing files.
> > It applies both the image's old backing file as well as the new backing
> > file:
> > 
> >   ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
> >                   old_backing_drv, &local_err);
> >   if (ret) {
> >       ...
> >   }
> >   if (out_baseimg[0]) {
> >       bs_new_backing = bdrv_new("new_backing", &error_abort);
> >       ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
> >                       new_backing_drv, &local_err);
> >       if (ret) {
> >           ...
> >       }
> >   }
> > 
> > The documentation only mentions the new backing file but it really
> > applies to both.
> > 
> > Suggested-by: Jeff Nelson <jenelson@redhat.com>
> > Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> > ---
> >  qemu-img.texi | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/qemu-img.texi b/qemu-img.texi
> > index 4380d56..7c2df14 100644
> > --- a/qemu-img.texi
> > +++ b/qemu-img.texi
> > @@ -341,7 +341,7 @@ string), then the image is rebased onto no backing file (i.e. it will exist
> >  independently of any backing file).
> >  
> >  @var{cache} specifies the cache mode to be used for @var{filename}, whereas
> > -@var{src_cache} specifies the cache mode for reading the new backing file.
> > +@var{src_cache} specifies the cache mode for reading backing file files.
> 
> Is "backing file files" intended, why not just "backing files"? :)

Ha!  Thanks for spotting that.  I managed to typo it.  Fixed in v2.

Stefan
diff mbox

Patch

diff --git a/qemu-img.texi b/qemu-img.texi
index 4380d56..7c2df14 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -341,7 +341,7 @@  string), then the image is rebased onto no backing file (i.e. it will exist
 independently of any backing file).
 
 @var{cache} specifies the cache mode to be used for @var{filename}, whereas
-@var{src_cache} specifies the cache mode for reading the new backing file.
+@var{src_cache} specifies the cache mode for reading backing file files.
 
 There are two different modes in which @code{rebase} can operate:
 @table @option