From patchwork Fri Oct 9 08:58:35 2009 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kevin Wolf X-Patchwork-Id: 35601 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 2F895B7B96 for ; Fri, 9 Oct 2009 20:02:20 +1100 (EST) Received: from localhost ([127.0.0.1]:44395 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MwBMf-0003e4-KA for incoming@patchwork.ozlabs.org; Fri, 09 Oct 2009 05:02:17 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MwBKM-0002E1-1I for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:54 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MwBKG-00023n-Cu for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:53 -0400 Received: from [199.232.76.173] (port=37834 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MwBKG-00023d-4z for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:48 -0400 Received: from mx1.redhat.com ([209.132.183.28]:51352) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1MwBKF-00069J-9p for qemu-devel@nongnu.org; Fri, 09 Oct 2009 04:59:47 -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 n998xkGs006736 for ; Fri, 9 Oct 2009 04:59:46 -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 n998xheJ010976; Fri, 9 Oct 2009 04:59:45 -0400 From: Kevin Wolf To: qemu-devel@nongnu.org Date: Fri, 9 Oct 2009 10:58:35 +0200 Message-Id: <1255078717-5734-2-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 1/3] Documentation: Highlight placeholders in suboptions 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 Currently, suboptions (i.e. something like file=file for -drive) are rendered as @code, so we're losing any @var highlighting in the man pages. Replace them by @option, so that you actually can see what is a placeholder and what is meant verbatim. Signed-off-by: Kevin Wolf --- qemu-options.hx | 18 +++++++++--------- 1 files changed, 9 insertions(+), 9 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 3dd76b3..807814f 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -114,7 +114,7 @@ STEXI Define a new drive. Valid options are: -@table @code +@table @option @item file=@var{file} This option defines which disk image (@pxref{disk_images}) to use with this drive. If the filename contains comma, you must double it @@ -363,7 +363,7 @@ STEXI @item -usbdevice @var{devname} Add the USB device @var{devname}. @xref{usb_devices}. -@table @code +@table @option @item mouse Virtual Mouse. This will override the PS/2 mouse emulation when activated. @@ -521,7 +521,7 @@ DEF("vga", HAS_ARG, QEMU_OPTION_vga, STEXI @item -vga @var{type} Select type of VGA card to emulate. Valid values for @var{type} are -@table @code +@table @option @item cirrus Cirrus Logic GD5446 Video card. All Windows versions starting from Windows 95 should recognize and use this graphic card. For optimal @@ -568,7 +568,7 @@ tablet}). When using the VNC display, you must use the @option{-k} parameter to set the keyboard layout if you are not using en-us. Valid syntax for the @var{display} is -@table @code +@table @option @item @var{host}:@var{d} @@ -591,7 +591,7 @@ can be used to later start the VNC server. Following the @var{display} value there may be one or more @var{option} flags separated by commas. Valid options are -@table @code +@table @option @item reverse @@ -861,7 +861,7 @@ for a list of available devices for your target. Use the user mode network stack which requires no administrator privilege to run. Valid options are: -@table @code +@table @option @item vlan=@var{n} Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). @@ -1105,7 +1105,7 @@ machines have none. @anchor{bt-hcis} The following three types are recognized: -@table @code +@table @option @item -bt hci,null (default) The corresponding Bluetooth HCI assumes no internal logic and will not respond to any HCI commands or emit events. @@ -1139,7 +1139,7 @@ Emulate a bluetooth device @var{dev} and place it in network @var{n} (default @code{0}). QEMU can only emulate one type of bluetooth devices currently: -@table @code +@table @option @item keyboard Virtual wireless keyboard implementing the HIDP bluetooth profile. @end table @@ -1215,7 +1215,7 @@ ports. Use @code{-serial none} to disable all serial ports. Available character devices are: -@table @code +@table @option @item vc[:WxH] Virtual console. Optionally, a width and height can be given in pixel with @example