Patchwork [qemu-kvm] docs: updated qemu-img man page and qemu-doc to reflect VHDX support.

login
register
mail settings
Submitter Jeff Cody
Date Dec. 17, 2013, 6:41 p.m.
Message ID <4ce3097653ce4850e74efa9abb41561babfd38ee.1387305554.git.jcody@redhat.com>
Download mbox | patch
Permalink /patch/302422/
State New
Headers show

Comments

Jeff Cody - Dec. 17, 2013, 6:41 p.m.
The man page for qemu-img, and the qemu-doc, did not mention VHDX
as a supported format.  This adds in reference to VHDX in those
documents.

Signed-off-by: Jeff Cody <jcody@redhat.com>
---
 qemu-doc.texi | 15 +++++++++++++++
 qemu-img.texi |  4 ++--
 2 files changed, 17 insertions(+), 2 deletions(-)
Stefan Weil - Dec. 17, 2013, 6:51 p.m.
Am 17.12.2013 19:41, schrieb Jeff Cody:
> The man page for qemu-img, and the qemu-doc, did not mention VHDX
> as a supported format.  This adds in reference to VHDX in those
> documents.
>
> Signed-off-by: Jeff Cody <jcody@redhat.com>
> ---
>  qemu-doc.texi | 15 +++++++++++++++
>  qemu-img.texi |  4 ++--
>  2 files changed, 17 insertions(+), 2 deletions(-)
>
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 185dd47..10b4ae9 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -654,6 +654,21 @@ Supported options:
>  Specifies which VHD subformat to use. Valid options are
>  @code{dynamic} (default) and @code{fixed}.
>  @end table
> +
> +@item VHDX
> +Hyper-V compatible image format (VHDX).
> +Supported options:
> +@table @code
> +@item subformat
> +Specifies which VHDX subformat to use. Valid options are
> +@code{dynamic} (default) and @code{fixed}.
> +@item block_state_zero
> +Force use of payload blocks of type 'ZERO'.
> +@item block_size
> +Block Size; min 1MB, max 256MB.  0 means auto-calculate based on image size.

Please add blanks: 1 MB, max 256 MB.

> +@item log_size
> +Log size; min 1MB.

1 MB

> +@end table
>  @end table
>  
>  @subsubsection Read-only formats
> diff --git a/qemu-img.texi b/qemu-img.texi
> index be31191..1bba91e 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -431,8 +431,8 @@ This option can only be enabled if @code{compat=1.1} is specified.
>  
>  @item Other
>  QEMU also supports various other image file formats for compatibility with
> -older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), qcow1
> -and QED. For a full list of supported formats see @code{qemu-img --help}.
> +older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
> +qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
>  For a more detailed description of these formats, see the QEMU Emulation User
>  Documentation.

Otherwise okay. I appreciate efforts to improve the documentation.

Reviewed-by: Stefan Weil <sw@weilnetz.de>
Jeff Cody - Dec. 17, 2013, 6:54 p.m.
On Tue, Dec 17, 2013 at 07:51:49PM +0100, Stefan Weil wrote:
> Am 17.12.2013 19:41, schrieb Jeff Cody:
> > The man page for qemu-img, and the qemu-doc, did not mention VHDX
> > as a supported format.  This adds in reference to VHDX in those
> > documents.
> >
> > Signed-off-by: Jeff Cody <jcody@redhat.com>
> > ---
> >  qemu-doc.texi | 15 +++++++++++++++
> >  qemu-img.texi |  4 ++--
> >  2 files changed, 17 insertions(+), 2 deletions(-)
> >
> > diff --git a/qemu-doc.texi b/qemu-doc.texi
> > index 185dd47..10b4ae9 100644
> > --- a/qemu-doc.texi
> > +++ b/qemu-doc.texi
> > @@ -654,6 +654,21 @@ Supported options:
> >  Specifies which VHD subformat to use. Valid options are
> >  @code{dynamic} (default) and @code{fixed}.
> >  @end table
> > +
> > +@item VHDX
> > +Hyper-V compatible image format (VHDX).
> > +Supported options:
> > +@table @code
> > +@item subformat
> > +Specifies which VHDX subformat to use. Valid options are
> > +@code{dynamic} (default) and @code{fixed}.
> > +@item block_state_zero
> > +Force use of payload blocks of type 'ZERO'.
> > +@item block_size
> > +Block Size; min 1MB, max 256MB.  0 means auto-calculate based on image size.
> 
> Please add blanks: 1 MB, max 256 MB.
> 
> > +@item log_size
> > +Log size; min 1MB.
> 
> 1 MB
>

OK, thanks.

> > +@end table
> >  @end table
> >  
> >  @subsubsection Read-only formats
> > diff --git a/qemu-img.texi b/qemu-img.texi
> > index be31191..1bba91e 100644
> > --- a/qemu-img.texi
> > +++ b/qemu-img.texi
> > @@ -431,8 +431,8 @@ This option can only be enabled if @code{compat=1.1} is specified.
> >  
> >  @item Other
> >  QEMU also supports various other image file formats for compatibility with
> > -older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), qcow1
> > -and QED. For a full list of supported formats see @code{qemu-img --help}.
> > +older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
> > +qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
> >  For a more detailed description of these formats, see the QEMU Emulation User
> >  Documentation.
> 
> Otherwise okay. I appreciate efforts to improve the documentation.
> 
> Reviewed-by: Stefan Weil <sw@weilnetz.de>
>

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 185dd47..10b4ae9 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -654,6 +654,21 @@  Supported options:
 Specifies which VHD subformat to use. Valid options are
 @code{dynamic} (default) and @code{fixed}.
 @end table
+
+@item VHDX
+Hyper-V compatible image format (VHDX).
+Supported options:
+@table @code
+@item subformat
+Specifies which VHDX subformat to use. Valid options are
+@code{dynamic} (default) and @code{fixed}.
+@item block_state_zero
+Force use of payload blocks of type 'ZERO'.
+@item block_size
+Block Size; min 1MB, max 256MB.  0 means auto-calculate based on image size.
+@item log_size
+Log size; min 1MB.
+@end table
 @end table
 
 @subsubsection Read-only formats
diff --git a/qemu-img.texi b/qemu-img.texi
index be31191..1bba91e 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -431,8 +431,8 @@  This option can only be enabled if @code{compat=1.1} is specified.
 
 @item Other
 QEMU also supports various other image file formats for compatibility with
-older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), qcow1
-and QED. For a full list of supported formats see @code{qemu-img --help}.
+older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
+qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
 For a more detailed description of these formats, see the QEMU Emulation User
 Documentation.