Patchwork [v2] qemu-img: document qed format on qemu-img man page

login
register
mail settings
Submitter Stefan Hajnoczi
Date June 13, 2012, 1:29 p.m.
Message ID <1339594155-9783-1-git-send-email-stefanha@linux.vnet.ibm.com>
Download mbox | patch
Permalink /patch/164674/
State New
Headers show

Comments

Stefan Hajnoczi - June 13, 2012, 1:29 p.m.
The qemu-img.1 man page is missing the qed format from its list of
supported formats.  Document the image creation options for qed.

Suggested-by: Michael Tokarev <mjt@tls.msk.ru>
Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
---
v2:
 * Add mention of cache=directsync [Kevin]
 * Mention qcow2 [Kevin]

 qemu-img.texi |   23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
Kevin Wolf - June 13, 2012, 3:40 p.m.
Am 13.06.2012 15:29, schrieb Stefan Hajnoczi:
> The qemu-img.1 man page is missing the qed format from its list of
> supported formats.  Document the image creation options for qed.
> 
> Suggested-by: Michael Tokarev <mjt@tls.msk.ru>
> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>

Thanks, applied to the block branch.

Kevin

Patch

diff --git a/qemu-img.texi b/qemu-img.texi
index 6fc3c28..9cee2ea 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -232,6 +232,29 @@  to grow.
 
 @end table
 
+@item qed
+Image format with support for backing files and compact image files (when your
+filesystem or transport medium does not support holes).  Good performance due
+to less metadata than the more featureful qcow2 format, especially with
+cache=writethrough or cache=directsync.  Consider using qcow2 which will soon
+have a similar optimization and is most actively developed.
+
+Supported options:
+@table @code
+@item backing_file
+File name of a base image (see @option{create} subcommand).
+@item backing_fmt
+Image file format of backing file (optional).  Useful if the format cannot be
+autodetected because it has no header, like some vhd/vpc files.
+@item cluster_size
+Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
+cluster sizes can improve the image file size whereas larger cluster sizes
+generally provide better performance.
+@item table_size
+Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
+and 16).  There is normally no need to change this value but this option can be
+used for performance benchmarking.
+@end table
 
 @item qcow
 Old QEMU image format. Left for compatibility.