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] Documentation: Add missing documentation for qdev related command line options
Date: Sat, 16 Jan 2010 18:19:44 +0100	[thread overview]
Message-ID: <1263662384-1459-1-git-send-email-weil@mail.berlios.de> (raw)

The command line options -device, -nodefaults, -readconfig,
-writeconfig had entries for command line help, but
documentation for texi and derived formats (man, html, info)
was missing.

This also required moving "@end table" to the end of
qemu-options.hx again.

Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
 qemu-options.hx |   25 +++++++++++++++++++++----
 1 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index e2edd71..b2d04e2 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -404,6 +404,12 @@ ETEXI
 
 DEF("device", HAS_ARG, QEMU_OPTION_device,
     "-device driver[,options]  add device\n")
+STEXI
+@item -device @var{driver}[,@var{option}[,...]]
+Add device @var{driver}. Depending on the device type,
+@var{option} (typically @var{key}=@var{value}) may be useful.
+ETEXI
+
 DEF("name", HAS_ARG, QEMU_OPTION_name,
     "-name string1[,process=string2]\n"
     "                set the name of the guest\n"
@@ -1905,6 +1911,8 @@ ETEXI
 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
     "-nodefaults     don't create default devices\n")
 STEXI
+@item -nodefaults
+Don't create default devices.
 ETEXI
 
 #ifndef _WIN32
@@ -1927,10 +1935,6 @@ Immediately before starting guest execution, drop root privileges, switching
 to the specified user.
 ETEXI
 
-STEXI
-@end table
-ETEXI
-
 #if defined(TARGET_SPARC) || defined(TARGET_PPC)
 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
     "-prom-env variable=value\n"
@@ -1946,6 +1950,19 @@ DEF("old-param", 0, QEMU_OPTION_old_param,
 #endif
 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
     "-readconfig <file>\n")
+STEXI
+@item -readconfig @var{file}
+Read device configuration from @var{file}.
+ETEXI
 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
     "-writeconfig <file>\n"
     "                read/write config file\n")
+STEXI
+@item -writeconfig @var{file}
+Write device configuration to @var{file}.
+ETEXI
+
+HXCOMM This is the last statement. Insert new options before this line!
+STEXI
+@end table
+ETEXI
-- 
1.6.5

             reply	other threads:[~2010-01-16 17:20 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-01-16 17:19 Stefan Weil [this message]
2010-01-18 10:09 ` [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options 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         ` [Qemu-devel] [PATCH 3/3] Documentation: Improve command line help for -device option Stefan Weil
2010-01-21 16:42         ` [Qemu-devel] [PATCH 2/3] qdev: Add help for property value 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=1263662384-1459-1-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).