Re: [Qemu-devel] [PATCH] qemu-options.hx: Change from recommending '?' to 'help'

[Eric Blake]

On 09/06/2012 07:54 AM, Peter Maydell wrote:
> Update the -help output and documentation so that it recommends
> 'help' rather than '?' for the various "list valid values for this
> option" cases. '?' is deprecated (as it can fail confusingly if
> not quoted), so it's better to steer users towards 'help'. ('?'
> still works, for backwards compatibility.)
> 
> This is the -help option part of the change otherwise done in
> commit c8057f9, since we are now past release 1.2 and free to
> change our help text without worrying about breaking libvirt.

Agreed on that point.

>  DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
>      "-machine [type=]name[,prop[=value][,...]]\n"
> -    "                selects emulated machine (-machine ? for list)\n"
> +    "                selects emulated machine (-machine help for list)\n"

Would it help to add some quoting?

"                selects emulated machine ('-machine help' for list)\n"
> @@ -64,11 +60,11 @@ HXCOMM Deprecated by -machine
>  DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
>  
>  DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
> -    "-cpu cpu        select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
> +    "-cpu cpu        select CPU (-cpu help for list)\n", QEMU_ARCH_ALL)

Here as well.

>  STEXI
>  @item -cpu @var{model}
>  @findex -cpu
> -Select CPU model (-cpu ? for list and additional feature selection)
> +Select CPU model (-cpu help for list and additional feature selection)

@code{-cpu help} here, to match the @code{-machine help} above.

>  ETEXI
>  
>  DEF("smp", HAS_ARG, QEMU_OPTION_smp,
> @@ -452,12 +448,12 @@ ETEXI
>  DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
>      "-soundhw c1,... enable audio support\n"
>      "                and only specified sound cards (comma separated list)\n"
> -    "                use -soundhw ? to get the list of supported cards\n"
> +    "                use -soundhw help to get the list of supported cards\n"

Similar comments apply to the rest of the patch...

-- 
Eric Blake   address@hidden    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature