[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 2/3] Documentation: Add missing tags to placeholders
From: |
Kevin Wolf |
Subject: |
[Qemu-devel] [PATCH 2/3] Documentation: Add missing tags to placeholders |
Date: |
Fri, 9 Oct 2009 10:58:36 +0200 |
Not all placeholders in options descriptions had the @var tag on them. Add the
tag so that it's clearly visible that they are placeholders.
Signed-off-by: Kevin Wolf <address@hidden>
---
qemu-doc.texi | 10 +++++-----
qemu-options.hx | 43 ++++++++++++++++++++++---------------------
2 files changed, 27 insertions(+), 26 deletions(-)
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 99d7f0d..7d3240c 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1342,11 +1342,11 @@ The following options are specific to the PowerPC
emulation:
@table @option
address@hidden -g WxH[xDEPTH]
address@hidden -g @address@hidden@var{DEPTH}]
Set the initial VGA graphic mode. The default is 800x600x15.
address@hidden -prom-env string
address@hidden -prom-env @var{string}
Set OpenBIOS variables in NVRAM, for example:
@@ -1442,12 +1442,12 @@ The following options are specific to the Sparc32
emulation:
@table @option
address@hidden -g WxHx[xDEPTH]
address@hidden -g @address@hidden@var{DEPTH}]
Set the initial TCX graphic mode. The default is 1024x768x8, currently
the only other possible mode is 1024x768x24.
address@hidden -prom-env string
address@hidden -prom-env @var{string}
Set OpenBIOS variables in NVRAM, for example:
@@ -1497,7 +1497,7 @@ The following options are specific to the Sparc64
emulation:
@table @option
address@hidden -prom-env string
address@hidden -prom-env @var{string}
Set OpenBIOS variables in NVRAM, for example:
diff --git a/qemu-options.hx b/qemu-options.hx
index 807814f..e86264e 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -217,22 +217,22 @@ DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
"-mtdblock file use 'file' as on-board Flash memory image\n")
STEXI
address@hidden -mtdblock file
-Use 'file' as on-board Flash memory image.
address@hidden -mtdblock @var{file}
+Use @var{file} as on-board Flash memory image.
ETEXI
DEF("sd", HAS_ARG, QEMU_OPTION_sd,
"-sd file use 'file' as SecureDigital card image\n")
STEXI
address@hidden -sd file
-Use 'file' as SecureDigital card image.
address@hidden -sd @var{file}
+Use @var{file} as SecureDigital card image.
ETEXI
DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
"-pflash file use 'file' as a parallel flash image\n")
STEXI
address@hidden -pflash file
-Use 'file' as a parallel flash image.
address@hidden -pflash @var{file}
+Use @var{file} as a parallel flash image.
ETEXI
DEF("boot", HAS_ARG, QEMU_OPTION_boot,
@@ -373,16 +373,17 @@ Pointer device that uses absolute coordinates (like a
touchscreen). This
means qemu is able to report the mouse position without having to grab the
mouse. Also overrides the PS/2 mouse emulation when activated.
address@hidden disk:address@hidden:file
address@hidden disk:address@hidden:@var{file}
Mass storage device based on file. The optional @var{format} argument
will be used rather than detecting the format. Can be used to specifiy
-format=raw to avoid interpreting an untrusted format header.
address@hidden to avoid interpreting an untrusted format header.
address@hidden host:bus.addr
-Pass through the host device identified by bus.addr (Linux only).
address@hidden host:@address@hidden
+Pass through the host device identified by @address@hidden (Linux only).
address@hidden host:vendor_id:product_id
-Pass through the host device identified by vendor_id:product_id (Linux only).
address@hidden host:@var{vendor_id}:@var{product_id}
+Pass through the host device identified by @var{vendor_id}:@var{product_id}
+(Linux only).
@item serial:address@hidden,address@hidden:@var{dev}
Serial converter to host character device @var{dev}, see @code{-serial} for the
@@ -392,7 +393,7 @@ available devices.
Braille device. This will use BrlAPI to display the braille output on a real
or fake device.
address@hidden net:options
address@hidden net:@var{options}
Network adapter that supports CDC ethernet and RNDIS protocols.
@end table
@@ -576,7 +577,7 @@ TCP connections will only be allowed from @var{host} on
display @var{d}.
By convention the TCP port is address@hidden Optionally, @var{host} can
be omitted in which case the server will accept connections from any host.
address@hidden @code{unix}:@var{path}
address@hidden unix:@var{path}
Connections will be allowed over UNIX domain sockets where @var{path} is the
location of a unix socket to listen for connections on.
@@ -611,7 +612,7 @@ The password must be set separately using the @code{change}
command in the
Require that client use TLS when communicating with the VNC server. This
uses anonymous TLS credentials so is susceptible to a man-in-the-middle
attack. It is recommended that this option be combined with either the
address@hidden or @var{x509verify} options.
address@hidden or @option{x509verify} options.
@item address@hidden/path/to/certificate/dir}
@@ -1216,7 +1217,7 @@ Use @code{-serial none} to disable all serial ports.
Available character devices are:
@table @option
address@hidden vc[:WxH]
address@hidden vc[:@address@hidden
Virtual console. Optionally, a width and height can be given in pixel with
@example
vc:800x600
@@ -1543,9 +1544,9 @@ DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
" enable virtual instruction counter with 2^N clock ticks
per\n" \
" instruction\n")
STEXI
address@hidden -icount [N|auto]
address@hidden -icount address@hidden|auto]
Enable virtual instruction counter. The virtual cpu will execute one
-instruction every 2^N ns of virtual time. If @code{auto} is specified
+instruction every address@hidden ns of virtual time. If @code{auto} is
specified
then the virtual cpu speed will be automatically adjusted to keep virtual
time within a few seconds of real time.
@@ -1608,7 +1609,7 @@ DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
"-echr chr set terminal escape character instead of ctrl-a\n")
STEXI
address@hidden -echr numeric_ascii_value
address@hidden -echr @var{numeric_ascii_value}
Change the escape character used for switching to the monitor when using
monitor and serial sharing. The default is @code{0x01} when using the
@code{-nographic} option. @code{0x01} is equal to pressing
@@ -1650,7 +1651,7 @@ DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
"-chroot dir Chroot to dir just before starting the VM.\n")
#endif
STEXI
address@hidden -chroot dir
address@hidden -chroot @var{dir}
Immediately before starting guest execution, chroot to the specified
directory. Especially useful in combination with -runas.
ETEXI
@@ -1660,7 +1661,7 @@ DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
"-runas user Change to user id user just before starting the VM.\n")
#endif
STEXI
address@hidden -runas user
address@hidden -runas @var{user}
Immediately before starting guest execution, drop root privileges, switching
to the specified user.
ETEXI
--
1.6.2.5