From patchwork Wed Jan 20 21:58:35 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: [3/3] Documentation: Improve command line help for -device option From: Stefan Weil X-Patchwork-Id: 43376 Message-Id: <1264024715-23417-3-git-send-email-weil@mail.berlios.de> To: QEMU Developers Cc: Date: Wed, 20 Jan 2010 22:58:35 +0100 * Fix column for help text. * Give some more help, especially for the new '?' parameters. Signed-off-by: Stefan Weil --- qemu-options.hx | 15 ++++++++++++--- 1 files changed, 12 insertions(+), 3 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index ee60d8a..ef82cac 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -403,11 +403,20 @@ Network adapter that supports CDC ethernet and RNDIS protocols. ETEXI DEF("device", HAS_ARG, QEMU_OPTION_device, - "-device driver[,options] add device\n") -STEXI -@item -device @var{driver}[,@var{option}[,...]] + "-device driver[,option[=value][,...]]\n" + " add device (based on driver) with default or\n" + " user defined options\n" + " use -device ? to print all possible drivers\n" + " use -device driver,? to print all possible options\n" + " use -device driver,option=? to print a help for value\n") +STEXI +@item -device @var{driver}[,@var{option}[=@var{value}][,...]] Add device @var{driver}. Depending on the device type, -@var{option} (typically @var{key}=@var{value}) may be useful. +@var{option} (with default or given @var{value}) may be useful. +To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use +@code{-device ?}, +@code{-device @var{driver},?} or +@code{-device @var{driver},@var{option}=?}. ETEXI DEF("name", HAS_ARG, QEMU_OPTION_name,