From: Eric Blake <eblake@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Anthony Liguori <aliguori@us.ibm.com>,
qemu-devel@nongnu.org, patches@linaro.org
Subject: Re: [Qemu-devel] [PATCH] qemu-options.hx: Change from recommending '?' to 'help'
Date: Thu, 06 Sep 2012 08:55:50 -0600 [thread overview]
Message-ID: <5048B976.7070508@redhat.com> (raw)
In-Reply-To: <1346939680-13238-1-git-send-email-peter.maydell@linaro.org>
[-- Attachment #1: Type: text/plain, Size: 2144 bytes --]
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 eblake@redhat.com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 617 bytes --]
next prev parent reply other threads:[~2012-09-06 14:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-06 13:54 [Qemu-devel] [PATCH] qemu-options.hx: Change from recommending '?' to 'help' Peter Maydell
2012-09-06 13:56 ` Daniel P. Berrange
2012-09-06 14:55 ` Eric Blake [this message]
2012-09-06 15:44 ` Peter Maydell
2012-09-25 13:10 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5048B976.7070508@redhat.com \
--to=eblake@redhat.com \
--cc=aliguori@us.ibm.com \
--cc=patches@linaro.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).