Re: [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read

[Max Reitz <mreitz@redhat.com>]

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

On 16.10.18 08:46, Marc-André Lureau wrote:
> Hi
> 
> On Mon, Oct 15, 2018 at 9:34 PM Max Reitz <mreitz@redhat.com> wrote:
>>
>> This adds some whitespace into the option help (including indentation)
>> and replaces '=' by ': ' (not least because '=' should be used for
>> values, not types).
> 
> Without strong preference, I like the '=' better: it's the expected
> syntax for the command line argument. (also, --help and man pages
> describe options with "foo=type", not "foo: type")

Define "strong".  I do believe that types are different from values, and
that '=' is reserved for values and never used with types.

It's not like I'll die when we keep '=', though, but it's definitely not
what I'd use.  Maybe "foo=<str>", but that feels overly cluttered when
compared to "foo: str".  (Especially when it comes to things like
"iothread=<link<iothread>>".)

>> Furthermore, the list name is no longer printed as
>> part of every line, but only once in advance, and only if the caller did
>> not print a caption already.
>>
>> Signed-off-by: Max Reitz <mreitz@redhat.com>
> 
> looks good to me otherwise

Well, if '=' is the only trouble, that's good. :-)

Max


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