Re: [Qemu-devel] [Qemu-block] [PATCH v3 0/3] throttle: improve command-line parameter documentation

[Stefan Hajnoczi]

On Wed, Mar 01, 2017 at 10:27:48PM +0100, Greg Kurz wrote:
> On Wed,  1 Mar 2017 11:50:23 +0000
> Stefan Hajnoczi <address@hidden> wrote:
> 
> > v3:
> >  * Added Patch 2 to fix invalid test parameters
> >  * Switched to nicer max < avg check [Berto]
> > v2:
> >  * Fixed s/bps/iops/ copy-paste error in Patch 1 [Berto]
> >  * Rephrased warning about guest hangs and errors [Berto]
> >  * Added Patch 2 to hide the internal .max value from the monitor
> > 
> > Patch 1 fleshes out the documentation for I/O throttling command-line
> > parameters.
> > 
> > Patch 2 hides an internal value that was being exposed to users via the
> > monitor and caused confusion.
> > 
> > I ended up not adding QMP-style throttling.* names to the command-line
> > documentation because the names are very long and unlikely to be used.  I
> > couldn't see a nice way of adding them while still keeping the documentation
> > readable.
> > 
> 
> I only see this series now and it's a bit unfortunate... throttling options
> are now also available for fsdev. Only QMP-style names were added though,
> and they appear in the documentation. I agree the names are long, and the
> result isn't pretty on 80 columns, but it is readable still.
> 
> I don't really want to add code, just to have shorter names and a prettier
> output. But it would be a good thing for fsdev to benefit from this new
> documentation... any suggestion how to do that ?

I think another patch series would be good to:
1. Document QMP-style names for -drive
2. Reference throttling parameter documention in a common place for both
   -fsdev and -drive.

I'll do that.  This is QEMU 2.10 material anyway (it has missed the
freeze deadline), so there's no time pressure.

Stefan

signature.asc
Description: PGP signature