qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Stefan Weil <weil@mail.berlios.de>
To: QEMU Developers <qemu-devel@nongnu.org>
Subject: [Qemu-devel] [PATCH 3/3] Documentation: Improve command line help for -device option
Date: Wed, 20 Jan 2010 22:58:35 +0100	[thread overview]
Message-ID: <1264024715-23417-3-git-send-email-weil@mail.berlios.de> (raw)
In-Reply-To: <1264024715-23417-2-git-send-email-weil@mail.berlios.de>

* Fix column for help text.

* Give some more help, especially for the new '?' parameters.

Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
 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,
-- 
1.6.5

  reply	other threads:[~2010-01-20 21:59 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-01-16 17:19 [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options Stefan Weil
2010-01-18 10:09 ` Markus Armbruster
2010-01-18 19:32   ` Stefan Weil
2010-01-19  9:38     ` Markus Armbruster
2010-01-20 22:05       ` Stefan Weil
2010-01-21 16:45         ` Markus Armbruster
2010-01-19 13:32     ` [Qemu-devel] " Michael S. Tsirkin
2010-01-20 21:58     ` [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties Stefan Weil
2010-01-20 21:58       ` [Qemu-devel] [PATCH 2/3] qdev: Add help for property value Stefan Weil
2010-01-20 21:58         ` Stefan Weil [this message]
2010-01-21 16:42         ` Markus Armbruster
2010-01-21 16:38       ` [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties Markus Armbruster
2010-01-21 16:44         ` Markus Armbruster
2010-01-21 17:28           ` Gerd Hoffmann
2010-01-20 14:55 ` [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options Anthony Liguori

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=1264024715-23417-3-git-send-email-weil@mail.berlios.de \
    --to=weil@mail.berlios.de \
    --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).