[Qemu-devel] [PATCH 3/3] Documentation: Add options to image format descriptions

[Kevin Wolf]

Explain the existing format specific options that can be used with qemu-img
create/convert -o ...

Signed-off-by: Kevin Wolf <address@hidden>
---
 qemu-img.texi |   46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 45 insertions(+), 1 deletions(-)

diff --git a/qemu-img.texi b/qemu-img.texi
index 2d0106b..ac97854 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -31,7 +31,7 @@ is the destination disk image filename
 @item options
 is a comma separated list of format specific options in a
 name=value format. Use @code{-o ?} for an overview of the options supported
-by the used format
+by the used format or see the format descriptions below for details.
 
 
 @item -c
@@ -132,10 +132,42 @@ images (useful if your filesystem does not supports 
holes, for example
 on Windows), optional AES encryption, zlib based compression and
 support of multiple VM snapshots.
 
+Supported options:
address@hidden @code
address@hidden backing_file
+File name of a base image (see @option{create} subcommand)
address@hidden backing_fmt
+Image format of the base image
address@hidden encryption
+If this option is set to @code{on}, the image is encrypted.
+
 Encryption uses the AES format which is very secure (128 bit keys). Use
 a long password (16 characters) to get maximum protection.
+
address@hidden cluster_size
+Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
+sizes can improve the image file size whereas larger cluster sizes generally
+provide better performance.
+
address@hidden preallocation
+Preallocation mode (allowed values: off, metadata). An image with preallocated
+metadata is initially larger but can improve performance when the image needs
+to grow.
+
address@hidden table
+
+
 @item qcow
 Old QEMU image format. Left for compatibility.
+
+Supported options:
address@hidden @code
address@hidden backing_file
+File name of a base image (see @option{create} subcommand)
address@hidden encryption
+If this option is set to @code{on}, the image is encrypted.
address@hidden table
+
 @item cow
 User Mode Linux Copy On Write image format. Used to be the only growable
 image format in QEMU. It is supported only for compatibility with
@@ -144,6 +176,18 @@ previous versions. It does not work on win32.
 VirtualBox 1.1 compatible image format.
 @item vmdk
 VMware 3 and 4 compatible image format.
+
+Supported options:
address@hidden @code
address@hidden backing_fmt
+Image format of the base image
address@hidden compat6
+Create a VMDK version 6 image (instead of version 4)
address@hidden table
+
address@hidden vpc
+VirtualPC compatible image format (VHD).
+
 @item cloop
 Linux Compressed Loop image, useful only to reuse directly compressed
 CD-ROM images present for example in the Knoppix CD-ROMs.
-- 
1.6.2.5