From patchwork Fri Oct 9 08:58:36 2009 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kevin Wolf X-Patchwork-Id: 35602 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 54F0AB7BAB for ; Fri, 9 Oct 2009 20:03:49 +1100 (EST) Received: from localhost ([127.0.0.1]:48670 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MwBO6-00041v-Hs for incoming@patchwork.ozlabs.org; Fri, 09 Oct 2009 05:03:46 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MwBKN-0002FU-PN for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:55 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MwBKI-00028G-Eh for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:55 -0400 Received: from [199.232.76.173] (port=37835 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MwBKI-000282-1S for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:50 -0400 Received: from mx1.redhat.com ([209.132.183.28]:15537) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1MwBKH-00069Z-Dc for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:49 -0400 Received: from int-mx08.intmail.prod.int.phx2.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id n998xmgw008834 for ; Fri, 9 Oct 2009 04:59:48 -0400 Received: from localhost.localdomain (vpn2-9-2.ams2.redhat.com [10.36.9.2]) by int-mx08.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id n998xheK010976; Fri, 9 Oct 2009 04:59:46 -0400 From: Kevin Wolf To: qemu-devel@nongnu.org Date: Fri, 9 Oct 2009 10:58:36 +0200 Message-Id: <1255078717-5734-3-git-send-email-kwolf@redhat.com> In-Reply-To: <1255078717-5734-1-git-send-email-kwolf@redhat.com> References: <1255078717-5734-1-git-send-email-kwolf@redhat.com> X-Scanned-By: MIMEDefang 2.67 on 10.5.11.21 X-detected-operating-system: by monty-python.gnu.org: Genre and OS details not recognized. Cc: Kevin Wolf Subject: [Qemu-devel] [PATCH 2/3] Documentation: Add missing tags to placeholders X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org 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 --- 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 -@item -g WxH[xDEPTH] +@item -g @var{W}x@var{H}[x@var{DEPTH}] Set the initial VGA graphic mode. The default is 800x600x15. -@item -prom-env string +@item -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 -@item -g WxHx[xDEPTH] +@item -g @var{W}x@var{H}x[x@var{DEPTH}] Set the initial TCX graphic mode. The default is 1024x768x8, currently the only other possible mode is 1024x768x24. -@item -prom-env string +@item -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 -@item -prom-env string +@item -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 -@item -mtdblock file -Use 'file' as on-board Flash memory image. +@item -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 -@item -sd file -Use 'file' as SecureDigital card image. +@item -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 -@item -pflash file -Use 'file' as a parallel flash image. +@item -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. -@item disk:[format=@var{format}]:file +@item disk:[format=@var{format}]:@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. +@code{format=raw} to avoid interpreting an untrusted format header. -@item host:bus.addr -Pass through the host device identified by bus.addr (Linux only). +@item host:@var{bus}.@var{addr} +Pass through the host device identified by @var{bus}.@var{addr} (Linux only). -@item host:vendor_id:product_id -Pass through the host device identified by vendor_id:product_id (Linux only). +@item host:@var{vendor_id}:@var{product_id} +Pass through the host device identified by @var{vendor_id}:@var{product_id} +(Linux only). @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@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. -@item net:options +@item 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 5900+@var{d}. Optionally, @var{host} can be omitted in which case the server will accept connections from any host. -@item @code{unix}:@var{path} +@item 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 -@var{x509} or @var{x509verify} options. +@option{x509} or @option{x509verify} options. @item x509=@var{/path/to/certificate/dir} @@ -1216,7 +1217,7 @@ Use @code{-serial none} to disable all serial ports. Available character devices are: @table @option -@item vc[:WxH] +@item vc[:@var{W}x@var{H}] 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 -@item -icount [N|auto] +@item -icount [@var{N}|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 2^@var{N} 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 -@item -echr numeric_ascii_value +@item -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 -@item -chroot dir +@item -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 -@item -runas user +@item -runas @var{user} Immediately before starting guest execution, drop root privileges, switching to the specified user. ETEXI