diff mbox

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

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

Commit Message

Stefan Hajnoczi Sept. 2, 2014, 10:01 a.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

Max Reitz Sept. 2, 2014, 7:10 p.m. UTC | #1
On 02.09.2014 12:01, 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(-)

Reviewed-by: Max Reitz <mreitz@redhat.com>
diff mbox

Patch

diff --git a/qemu-img.texi b/qemu-img.texi
index 4380d56..cc4668e 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 files.
 
 There are two different modes in which @code{rebase} can operate:
 @table @option