Re: [Qemu-devel] [PATCH 3/3] doc: Document driver-specific -blockdev options

[Eric Blake <eblake@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 2016 bytes --]

On 09/22/2016 10:42 AM, Kevin Wolf wrote:
> This documents the driver-specific options for the raw, qcow2 and file
> block drivers for the man page. For everything else, we refer to the
> QAPI documentation.
> 
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
>  qemu-options.hx | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 62 insertions(+)
> 

>  
> +@item Driver-specific options for @code{file}
> +@table @code
> +@item filename
> +The path to the image file in the local filesystem
> +@item aio
> +Specifies the AIO backend (threads/native, default: threads)
> +@end table
> +
> +@item Driver-specific options for @code{raw}
> +@table @code
> +@item file
> +Reference to or definition of the data source block device
> +@end table

Would an example command line make things any easier to read, for giving
hints on how many dotted names are needed as you describe further
nesting levels in relation to the top level?

> +@item cache-clean-interval
> +Clean unused entries in the L2 and refcount caches. The interval is in seconds.
> +The default value is 0 and it disables this feature.
> +
> +@item pass-discard-request
> +Whether discard requests to the qcow2 device should be forwarded to the data
> +source (on/off)
> +
> +@item pass-discard-snapshot
> +Whether discard requests for the data source should be issued when a snapshot
> +operation (e.g. deleting a snapshot) frees clusters in the qcow2 file (on/off)
> +
> +@item pass-discard-other
> +Whether discard requests for the data source should be issued on other
> +occasions where a cluster gets freed (on/off)

I like that cache-clean-interval mentioned a default; should these other
lines do likewise?

At any rate, those ideas can be followups if desired, as this patch is
strictly an improvement.

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]