[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns
From: |
Eric Blake |
Subject: |
Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns |
Date: |
Wed, 13 Jan 2021 16:15:55 -0600 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.0 |
On 1/13/21 3:42 PM, John Snow wrote:
> On 1/13/21 4:48 AM, Stefan Hajnoczi wrote:
>>> QEMU options are single dash with double dash accepted for
>>> compatibility but
>>> help and other docs have single dash so these (and below) should be
>>> -trace.
>>> (Also a bit less typing for otherwise already way too long command
>>> lines.)
>> Is this documented somewhere?
>>
>> I was under the impression that '-' is legacy syntax and '--' is the
>> preferred syntax. There are examples of '--' on the QEMU man page.
Historically, uses of 'getopt_long()' support only double dash, while
'getopt_long_only()' support both single and double. While qemu does
not use getopt_long_only() (because it rolls its own parser instead), it
certainly tries to behave as if it does. Meanwhile, our other tools
like qemu-img or qemu-storage-daemon use getopt_long(). I'm in favor of
preferring the double-dash in documentation, even when single-dash
works, especially for any option (like --trace) that is used for more
tools than just qemu proper, because it makes for easier copy-paste
between options that work for all tools in the qemu suite rather than
just qemu.
>>
>> Let's reach agreement, document it, and then make the documentation
>> consistent.
>>
>> Stefan
>
> My naive impression was that double-dash is the preferred idiom in
> linuxdom in general for any multi-character option.
>
> We might hang on to single-dash for backwards compatibility, but I doubt
> we want to enshrine that as our preferred way.
>
> Is there a reasoning I am unaware of?
Continuing to document '-machine' instead of '--machine' for qemu is
debatable because we don't support 'qemu-img --machine' or
'qemu-storage-daemon --machine'; but since 'qemu-img -trace' is an error
while 'qemu-img --trace' works, I'm definitely in favor of preferring
'--trace' everywhere in our docs.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
- [PATCH 0/2] trace: documentation improvements, Stefan Hajnoczi, 2021/01/12
- [PATCH 1/2] trace: document how to specify multiple --trace patterns, Stefan Hajnoczi, 2021/01/12
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, Philippe Mathieu-Daudé, 2021/01/12
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, BALATON Zoltan, 2021/01/12
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, John Snow, 2021/01/13
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns,
Eric Blake <=
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, John Snow, 2021/01/13
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, BALATON Zoltan, 2021/01/13
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, John Snow, 2021/01/13
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, Stefan Hajnoczi, 2021/01/14
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, BALATON Zoltan, 2021/01/14
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, Stefan Hajnoczi, 2021/01/14
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, Eric Blake, 2021/01/19
- Re: [PATCH 1/2] trace: document how to specify multiple --trace patterns, John Snow, 2021/01/14
[PATCH 2/2] trace: update docs with meson build information, Stefan Hajnoczi, 2021/01/12