[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read
From: |
Max Reitz |
Subject: |
Re: [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read |
Date: |
Fri, 19 Oct 2018 11:59:26 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.0 |
On 16.10.18 08:46, Marc-André Lureau wrote:
> Hi
>
> On Mon, Oct 15, 2018 at 9:34 PM Max Reitz <address@hidden> 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 <address@hidden>
>
> looks good to me otherwise
Well, if '=' is the only trouble, that's good. :-)
Max
signature.asc
Description: OpenPGP digital signature
- [Qemu-devel] [PATCH 0/5] Various option help readability improvement suggestions, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 2/5] chardev: Indent list of chardevs, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 4/5] object: Make option help nicer to read, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 3/5] qdev-monitor: Make device options help nicer, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 5/5] fw_cfg: Drop newline in @file description, Max Reitz, 2018/10/15
- [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read, Max Reitz, 2018/10/15