Re: [Qemu-devel] [PATCH 2/2] qemu-nbd: Minor texi updates

[Sitsofe Wheeler <sitsofe@yahoo.com>]

On Mon, Jan 04, 2016 at 11:16:03AM -0700, Eric Blake wrote:
> On 12/30/2015 12:57 PM, Sitsofe Wheeler wrote:
> > +@item -f, --format=@var{fmt}
> > +force the use of the block driver for format @var{fmt} instead of
> > +auto-detecting
> 
> Why are you abbreviating 'format' to 'fmt'? Oh, because that's how the
> other duplicate one was worded.

The problem is who to be consistent with? There are a few choices:
o qemu(1)
o qemu --help
o qemu-img(1)
o qemu-img --help
o qemu-nbd --help
o (For NBD options) nbd-server(1)

In the end I decided to try and avoid changing what was already there.

> Should probably start with 'Force', to match the capitalization used
> earlier....
> 
> >  @item -r, --read-only
> >  export read-only
> >  @item -P, --partition=@var{num}
> > @@ -44,17 +45,22 @@ the emulator's @code{-drive cache=...} option for allowed values.
> >  choose asynchronous I/O mode between @samp{threads} (the default)
> >  and @samp{native} (Linux only).
> >  @item --discard=@var{discard}
> > -toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
> 
> ...then again, later lines are not starting with upper case. Maybe
> that's worth its own patch to make it uniformly consistent?

OK I've posted an updated patch set with the capitalisation fixed as
another patch.

> > +@item --detect-zeroes=@var{detect-zeroes}
> > +enables the automatic conversion of plain zero writes by the OS to driver
> > +specific optimized zero write commands.  @var{detect-zeroes} is one of
> 
> I'd probably write this one as 'driver-specific'

OK I've changed this in the updated patch set (although this makes
things inconsistent with qemu(1)).

-- 
Sitsofe | http://sucs.org/~sits/