* [Qemu-devel] [PATCH] Document command line options with single dash
@ 2018-07-16 19:12 BALATON Zoltan
2018-07-17 7:43 ` Thomas Huth
0 siblings, 1 reply; 3+ messages in thread
From: BALATON Zoltan @ 2018-07-16 19:12 UTC (permalink / raw)
To: qemu-devel, qemu-trivial; +Cc: Thomas Huth, Michael S. Tsirkin
QEMU options have a single dash (but also work as double dash for
convenience and compatibility). Most options are listed with single
dash in command line help but some were listed with two dashes.
Normalize these to have the same format as the others.
Left --preconfig as that is mentioned as double dash everywhere so I
assume that is the preferred form for that.
Signed-off-by: BALATON Zoltan <balaton@eik.bme.hu>
---
qemu-options.hx | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/qemu-options.hx b/qemu-options.hx
index 371c427..b1bf0f4 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -471,7 +471,7 @@ STEXI
@item -balloon virtio[,addr=@var{addr}]
@findex -balloon
Enable virtio balloon device, optionally with PCI address @var{addr}. This
-option is deprecated, use @option{--device virtio-balloon} instead.
+option is deprecated, use @option{-device virtio-balloon} instead.
ETEXI
DEF("device", HAS_ARG, QEMU_OPTION_device,
@@ -2005,7 +2005,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
"-netdev hubport,id=str,hubid=n[,netdev=nd]\n"
" configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL)
DEF("nic", HAS_ARG, QEMU_OPTION_nic,
- "--nic [tap|bridge|"
+ "-nic [tap|bridge|"
#ifdef CONFIG_SLIRP
"user|"
#endif
@@ -2024,7 +2024,7 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic,
"socket][,option][,...][mac=macaddr]\n"
" initialize an on-board / default host NIC (using MAC address\n"
" macaddr) and connect it to the given host network backend\n"
- "--nic none use it alone to have zero network devices (the default is to\n"
+ "-nic none use it alone to have zero network devices (the default is to\n"
" provided a 'user' network connection)\n",
QEMU_ARCH_ALL)
DEF("net", HAS_ARG, QEMU_OPTION_net,
@@ -3339,7 +3339,7 @@ mlocking qemu and guest memory can be enabled via @option{mlock=on}
ETEXI
DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
- "--overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
+ "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
" run qemu with overcommit hints\n"
" mem-lock=on|off controls memory lock support (default: off)\n"
" cpu-pm=on|off controls cpu power management (default: off)\n",
--
2.7.6
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [Qemu-devel] [PATCH] Document command line options with single dash
2018-07-16 19:12 [Qemu-devel] [PATCH] Document command line options with single dash BALATON Zoltan
@ 2018-07-17 7:43 ` Thomas Huth
2018-07-17 11:00 ` Paolo Bonzini
0 siblings, 1 reply; 3+ messages in thread
From: Thomas Huth @ 2018-07-17 7:43 UTC (permalink / raw)
To: BALATON Zoltan, qemu-devel, qemu-trivial
Cc: Michael S. Tsirkin, Paolo Bonzini, Eric Blake
On 16.07.2018 21:12, BALATON Zoltan wrote:
> QEMU options have a single dash (but also work as double dash for
> convenience and compatibility). Most options are listed with single
> dash in command line help but some were listed with two dashes.
> Normalize these to have the same format as the others.
>
> Left --preconfig as that is mentioned as double dash everywhere so I
> assume that is the preferred form for that.
>
> Signed-off-by: BALATON Zoltan <balaton@eik.bme.hu>
> ---
> qemu-options.hx | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 371c427..b1bf0f4 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -471,7 +471,7 @@ STEXI
> @item -balloon virtio[,addr=@var{addr}]
> @findex -balloon
> Enable virtio balloon device, optionally with PCI address @var{addr}. This
> -option is deprecated, use @option{--device virtio-balloon} instead.
> +option is deprecated, use @option{-device virtio-balloon} instead.
> ETEXI
>
> DEF("device", HAS_ARG, QEMU_OPTION_device,
> @@ -2005,7 +2005,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
> "-netdev hubport,id=str,hubid=n[,netdev=nd]\n"
> " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL)
> DEF("nic", HAS_ARG, QEMU_OPTION_nic,
> - "--nic [tap|bridge|"
> + "-nic [tap|bridge|"
> #ifdef CONFIG_SLIRP
> "user|"
> #endif
> @@ -2024,7 +2024,7 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic,
> "socket][,option][,...][mac=macaddr]\n"
> " initialize an on-board / default host NIC (using MAC address\n"
> " macaddr) and connect it to the given host network backend\n"
> - "--nic none use it alone to have zero network devices (the default is to\n"
> + "-nic none use it alone to have zero network devices (the default is to\n"
> " provided a 'user' network connection)\n",
> QEMU_ARCH_ALL)
> DEF("net", HAS_ARG, QEMU_OPTION_net,
> @@ -3339,7 +3339,7 @@ mlocking qemu and guest memory can be enabled via @option{mlock=on}
> ETEXI
>
> DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
> - "--overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
> + "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
> " run qemu with overcommit hints\n"
> " mem-lock=on|off controls memory lock support (default: off)\n"
> " cpu-pm=on|off controls cpu power management (default: off)\n",
>
Acked-by: Thomas Huth <thuth@redhat.com>
... I'm in favour for consistency for the 3.0 release. But in the long
run, we should really come to a conclusion what we prefer (we still got
the double dash task at
https://wiki.qemu.org/BiteSizedTasks#Consistent_option_usage_in_documentation
)
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [Qemu-devel] [PATCH] Document command line options with single dash
2018-07-17 7:43 ` Thomas Huth
@ 2018-07-17 11:00 ` Paolo Bonzini
0 siblings, 0 replies; 3+ messages in thread
From: Paolo Bonzini @ 2018-07-17 11:00 UTC (permalink / raw)
To: Thomas Huth, BALATON Zoltan, qemu-devel, qemu-trivial
Cc: Michael S. Tsirkin, Eric Blake
On 17/07/2018 09:43, Thomas Huth wrote:
> On 16.07.2018 21:12, BALATON Zoltan wrote:
>> QEMU options have a single dash (but also work as double dash for
>> convenience and compatibility). Most options are listed with single
>> dash in command line help but some were listed with two dashes.
>> Normalize these to have the same format as the others.
>>
>> Left --preconfig as that is mentioned as double dash everywhere so I
>> assume that is the preferred form for that.
>>
>> Signed-off-by: BALATON Zoltan <balaton@eik.bme.hu>
>> ---
>> qemu-options.hx | 8 ++++----
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/qemu-options.hx b/qemu-options.hx
>> index 371c427..b1bf0f4 100644
>> --- a/qemu-options.hx
>> +++ b/qemu-options.hx
>> @@ -471,7 +471,7 @@ STEXI
>> @item -balloon virtio[,addr=@var{addr}]
>> @findex -balloon
>> Enable virtio balloon device, optionally with PCI address @var{addr}. This
>> -option is deprecated, use @option{--device virtio-balloon} instead.
>> +option is deprecated, use @option{-device virtio-balloon} instead.
>> ETEXI
>>
>> DEF("device", HAS_ARG, QEMU_OPTION_device,
>> @@ -2005,7 +2005,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
>> "-netdev hubport,id=str,hubid=n[,netdev=nd]\n"
>> " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL)
>> DEF("nic", HAS_ARG, QEMU_OPTION_nic,
>> - "--nic [tap|bridge|"
>> + "-nic [tap|bridge|"
>> #ifdef CONFIG_SLIRP
>> "user|"
>> #endif
>> @@ -2024,7 +2024,7 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic,
>> "socket][,option][,...][mac=macaddr]\n"
>> " initialize an on-board / default host NIC (using MAC address\n"
>> " macaddr) and connect it to the given host network backend\n"
>> - "--nic none use it alone to have zero network devices (the default is to\n"
>> + "-nic none use it alone to have zero network devices (the default is to\n"
>> " provided a 'user' network connection)\n",
>> QEMU_ARCH_ALL)
>> DEF("net", HAS_ARG, QEMU_OPTION_net,
>> @@ -3339,7 +3339,7 @@ mlocking qemu and guest memory can be enabled via @option{mlock=on}
>> ETEXI
>>
>> DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
>> - "--overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
>> + "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
>> " run qemu with overcommit hints\n"
>> " mem-lock=on|off controls memory lock support (default: off)\n"
>> " cpu-pm=on|off controls cpu power management (default: off)\n",
>>
>
> Acked-by: Thomas Huth <thuth@redhat.com>
>
> ... I'm in favour for consistency for the 3.0 release. But in the long
> run, we should really come to a conclusion what we prefer (we still got
> the double dash task at
> https://wiki.qemu.org/BiteSizedTasks#Consistent_option_usage_in_documentation
> )
>
Queued, thanks.
Paolo
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-07-17 11:00 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-07-16 19:12 [Qemu-devel] [PATCH] Document command line options with single dash BALATON Zoltan
2018-07-17 7:43 ` Thomas Huth
2018-07-17 11:00 ` Paolo Bonzini
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).