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

[Kevin Wolf]

Am 22.09.2016 um 21:02 hat Eric Blake geschrieben:
> 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 <address@hidden>
> > ---
> >  qemu-options.hx | 62 
> > +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 62 insertions(+)
> > 
> 
> >  
> > address@hidden Driver-specific options for @code{file}
> > address@hidden @code
> > address@hidden filename
> > +The path to the image file in the local filesystem
> > address@hidden aio
> > +Specifies the AIO backend (threads/native, default: threads)
> > address@hidden table
> > +
> > address@hidden Driver-specific options for @code{raw}
> > address@hidden @code
> > address@hidden file
> > +Reference to or definition of the data source block device
> > address@hidden 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?

Hm, I guess I could add an example command line to each driver section.
And probably the dotted syntax should be mentioned somewhere, too.

> > address@hidden 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.
> > +
> > address@hidden pass-discard-request
> > +Whether discard requests to the qcow2 device should be forwarded to the 
> > data
> > +source (on/off)
> > +
> > address@hidden 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)
> > +
> > address@hidden 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?

Actually I took most of these descriptions straight from the QAPI schema
comments, except that I added the allowed values sometimes. If the
default is missing, we should probably add it in both places.

Kevin

pgplNVu9evUqA.pgp
Description: PGP signature