* [Qemu-devel] [PATCH] Documentation: Add missing texi description for command line options
@ 2010-01-20 21:25 Stefan Weil
2010-01-26 22:03 ` Anthony Liguori
0 siblings, 1 reply; 2+ messages in thread
From: Stefan Weil @ 2010-01-20 21:25 UTC (permalink / raw)
To: QEMU Developers
Some more command line options had entries for command line help,
but documentation for texi and derived formats (man, html, info)
was missing.
For conditional options, the texi documentation was added
unconditionally.
This seems reasonable because typically man pages are
shared, and html users expect to see one documentation
(not several nearly identical documents for the different
systems).
Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
qemu-options.hx | 35 +++++++++++++++++++++++++++++++++++
1 files changed, 35 insertions(+), 0 deletions(-)
diff --git a/qemu-options.hx b/qemu-options.hx
index f5bd671..559f9ac 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -566,6 +566,8 @@ DEF("g", 1, QEMU_OPTION_g ,
"-g WxH[xDEPTH] Set the initial graphical resolution and depth\n")
#endif
STEXI
+@item -g @var{width}x@var{height}[x@var{depth}]
+Set the initial graphical resolution and depth (PPC, SPARC only).
ETEXI
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
@@ -1599,6 +1601,10 @@ non graphical mode.
ETEXI
DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
"-qmp dev like -monitor but opens in 'control' mode\n")
+STEXI
+@item -qmp @var{dev}
+Like -monitor but opens in 'control' mode.
+ETEXI
DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
"-mon chardev=[name][,mode=readline|control][,default]\n")
@@ -1715,6 +1721,16 @@ DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
"-xen-attach attach to existing xen domain\n"
" xend will use this when starting qemu\n")
#endif
+STEXI
+@item -xen-domid @var{id}
+Specify xen guest domain @var{id} (XEN only).
+@item -xen-create
+Create domain using xen hypercalls, bypassing xend.
+Warning: should not be used when xend is in use (XEN only).
+@item -xen-attach
+Attach to existing xen domain.
+xend will use this when starting qemu (XEN only).
+ETEXI
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
"-no-reboot exit instead of rebooting\n")
@@ -1902,16 +1918,22 @@ ETEXI
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
"-show-cursor show cursor\n")
STEXI
+@item -show-cursor
+Show cursor.
ETEXI
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
"-tb-size n set TB size\n")
STEXI
+@item -tb-size @var{n}
+Set TB size.
ETEXI
DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
"-incoming p prepare for incoming migration, listen on port p\n")
STEXI
+@item -incoming @var{port}
+Prepare for incoming migration, listen on @var{port}.
ETEXI
DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
@@ -1946,14 +1968,27 @@ DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
"-prom-env variable=value\n"
" set OpenBIOS nvram variables\n")
#endif
+STEXI
+@item -prom-env @var{variable}=@var{value}
+Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
+ETEXI
#if defined(TARGET_ARM) || defined(TARGET_M68K)
DEF("semihosting", 0, QEMU_OPTION_semihosting,
"-semihosting semihosting mode\n")
#endif
+STEXI
+@item -semihosting
+Semihosting mode (ARM, M68K only).
+ETEXI
#if defined(TARGET_ARM)
DEF("old-param", 0, QEMU_OPTION_old_param,
"-old-param old param mode\n")
#endif
+STEXI
+@item -old-param
+Old param mode (ARM only).
+ETEXI
+
DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
"-readconfig <file>\n")
STEXI
--
1.6.5
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [Qemu-devel] [PATCH] Documentation: Add missing texi description for command line options
2010-01-20 21:25 [Qemu-devel] [PATCH] Documentation: Add missing texi description for command line options Stefan Weil
@ 2010-01-26 22:03 ` Anthony Liguori
0 siblings, 0 replies; 2+ messages in thread
From: Anthony Liguori @ 2010-01-26 22:03 UTC (permalink / raw)
To: Stefan Weil; +Cc: QEMU Developers
On 01/20/2010 03:25 PM, Stefan Weil wrote:
> Some more command line options had entries for command line help,
> but documentation for texi and derived formats (man, html, info)
> was missing.
>
> For conditional options, the texi documentation was added
> unconditionally.
>
> This seems reasonable because typically man pages are
> shared, and html users expect to see one documentation
> (not several nearly identical documents for the different
> systems).
>
> Signed-off-by: Stefan Weil<weil@mail.berlios.de>
>
Applied all. Thanks.
Regards,
Anthony Liguori
> ---
> qemu-options.hx | 35 +++++++++++++++++++++++++++++++++++
> 1 files changed, 35 insertions(+), 0 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index f5bd671..559f9ac 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -566,6 +566,8 @@ DEF("g", 1, QEMU_OPTION_g ,
> "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n")
> #endif
> STEXI
> +@item -g @var{width}x@var{height}[x@var{depth}]
> +Set the initial graphical resolution and depth (PPC, SPARC only).
> ETEXI
>
> DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
> @@ -1599,6 +1601,10 @@ non graphical mode.
> ETEXI
> DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
> "-qmp dev like -monitor but opens in 'control' mode\n")
> +STEXI
> +@item -qmp @var{dev}
> +Like -monitor but opens in 'control' mode.
> +ETEXI
>
> DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
> "-mon chardev=[name][,mode=readline|control][,default]\n")
> @@ -1715,6 +1721,16 @@ DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
> "-xen-attach attach to existing xen domain\n"
> " xend will use this when starting qemu\n")
> #endif
> +STEXI
> +@item -xen-domid @var{id}
> +Specify xen guest domain @var{id} (XEN only).
> +@item -xen-create
> +Create domain using xen hypercalls, bypassing xend.
> +Warning: should not be used when xend is in use (XEN only).
> +@item -xen-attach
> +Attach to existing xen domain.
> +xend will use this when starting qemu (XEN only).
> +ETEXI
>
> DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
> "-no-reboot exit instead of rebooting\n")
> @@ -1902,16 +1918,22 @@ ETEXI
> DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
> "-show-cursor show cursor\n")
> STEXI
> +@item -show-cursor
> +Show cursor.
> ETEXI
>
> DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
> "-tb-size n set TB size\n")
> STEXI
> +@item -tb-size @var{n}
> +Set TB size.
> ETEXI
>
> DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
> "-incoming p prepare for incoming migration, listen on port p\n")
> STEXI
> +@item -incoming @var{port}
> +Prepare for incoming migration, listen on @var{port}.
> ETEXI
>
> DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
> @@ -1946,14 +1968,27 @@ DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
> "-prom-env variable=value\n"
> " set OpenBIOS nvram variables\n")
> #endif
> +STEXI
> +@item -prom-env @var{variable}=@var{value}
> +Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
> +ETEXI
> #if defined(TARGET_ARM) || defined(TARGET_M68K)
> DEF("semihosting", 0, QEMU_OPTION_semihosting,
> "-semihosting semihosting mode\n")
> #endif
> +STEXI
> +@item -semihosting
> +Semihosting mode (ARM, M68K only).
> +ETEXI
> #if defined(TARGET_ARM)
> DEF("old-param", 0, QEMU_OPTION_old_param,
> "-old-param old param mode\n")
> #endif
> +STEXI
> +@item -old-param
> +Old param mode (ARM only).
> +ETEXI
> +
> DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
> "-readconfig<file>\n")
> STEXI
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2010-01-26 22:03 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-01-20 21:25 [Qemu-devel] [PATCH] Documentation: Add missing texi description for command line options Stefan Weil
2010-01-26 22:03 ` Anthony Liguori
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).