qapi/block-core: update documentation of preallocation parameter

Add default and available values in the documentation block of
each block device or protocol that supports the 'preallocation'
parameter during the image creation.

Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190524075848.23781-2-sgarzare@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Stefano Garzarella 2019-05-24 09:58:46 +02:00 committed by Markus Armbruster
parent 4d2091023a
commit 64c7580c2e

View file

@ -4121,7 +4121,10 @@
# #
# @filename Filename for the new image file # @filename Filename for the new image file
# @size Size of the virtual disk in bytes # @size Size of the virtual disk in bytes
# @preallocation Preallocation mode for the new image (default: off) # @preallocation Preallocation mode for the new image (default: off;
# allowed values: off,
# falloc (if defined CONFIG_POSIX_FALLOCATE),
# full (if defined CONFIG_POSIX))
# @nocow Turn off copy-on-write (valid only on btrfs; default: off) # @nocow Turn off copy-on-write (valid only on btrfs; default: off)
# #
# Since: 2.12 # Since: 2.12
@ -4139,7 +4142,10 @@
# #
# @location Where to store the new image file # @location Where to store the new image file
# @size Size of the virtual disk in bytes # @size Size of the virtual disk in bytes
# @preallocation Preallocation mode for the new image (default: off) # @preallocation Preallocation mode for the new image (default: off;
# allowed values: off,
# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
# #
# Since: 2.12 # Since: 2.12
## ##
@ -4243,7 +4249,8 @@
# @backing-fmt Name of the block driver to use for the backing file # @backing-fmt Name of the block driver to use for the backing file
# @encrypt Encryption options if the image should be encrypted # @encrypt Encryption options if the image should be encrypted
# @cluster-size qcow2 cluster size in bytes (default: 65536) # @cluster-size qcow2 cluster size in bytes (default: 65536)
# @preallocation Preallocation mode for the new image (default: off) # @preallocation Preallocation mode for the new image (default: off;
# allowed values: off, falloc, full, metadata)
# @lazy-refcounts True if refcounts may be updated lazily (default: off) # @lazy-refcounts True if refcounts may be updated lazily (default: off)
# @refcount-bits Width of reference counts in bits (default: 16) # @refcount-bits Width of reference counts in bits (default: 16)
# #
@ -4426,7 +4433,8 @@
# @location Where to store the new image file # @location Where to store the new image file
# @size Size of the virtual disk in bytes # @size Size of the virtual disk in bytes
# @backing-file File name of a base image # @backing-file File name of a base image
# @preallocation Preallocation mode (allowed values: off, full) # @preallocation Preallocation mode for the new image (default: off;
# allowed values: off, full)
# @redundancy Redundancy of the image # @redundancy Redundancy of the image
# @object-size Object size of the image # @object-size Object size of the image
# #
@ -4461,8 +4469,8 @@
# #
# @file Node to create the image format on # @file Node to create the image format on
# @size Size of the virtual disk in bytes # @size Size of the virtual disk in bytes
# @preallocation Preallocation mode for the new image (allowed values: off, # @preallocation Preallocation mode for the new image (default: off;
# metadata; default: off) # allowed values: off, metadata)
# #
# Since: 2.12 # Since: 2.12
## ##