[Qemu-devel] [PATCH 0/3] Man page improvements

[Qemu-devel] [PATCH 0/3] Man page improvements

[Kevin Wolf]

I was pointed to some places in the qemu man page where we have things like
"file=file", with the placeholder "file" looking exactly the same as the option
string "file". So I decided to go through it and mark all placeholders as such.
While at it, I found that the msmouse description is in the wrong place.

Kevin Wolf (3):
  Documentation: Highlight placeholders in suboptions
  Documentation: Add missing tags to placeholders
  Documentation: Move msmouse description to an appropriate place

 qemu-doc.texi   |   10 ++++----
 qemu-options.hx |   65 ++++++++++++++++++++++++++++---------------------------
 2 files changed, 38 insertions(+), 37 deletions(-)

[Qemu-devel] [PATCH 1/3] Documentation: Highlight placeholders in suboptions

[Kevin Wolf]

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 <kwolf@redhat.com>
---
 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
-- 
1.6.2.5

[Qemu-devel] [PATCH 2/3] Documentation: Add missing tags to placeholders

[Kevin Wolf]

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 <kwolf@redhat.com>
---
 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
-- 
1.6.2.5

[Qemu-devel] [PATCH 3/3] Documentation: Move msmouse description to an appropriate place

[Kevin Wolf]

Putting it right in the middle of the explanation for "-serial udp" probably
wasn't the best idea.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
 qemu-options.hx |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index e86264e..eba9e52 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1251,8 +1251,6 @@ This implements UDP Net Console.
 When @var{remote_host} or @var{src_ip} are not specified
 they default to @code{0.0.0.0}.
 When not using a specified @var{src_port} a random port is automatically chosen.
-@item msmouse
-Three button serial mouse. Configure the guest to use Microsoft protocol.
 
 If you just want a simple readonly console you can use @code{netcat} or
 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
@@ -1326,6 +1324,8 @@ listening on port 4444 would be:
 Braille device.  This will use BrlAPI to display the braille output on a real
 or fake device.
 
+@item msmouse
+Three button serial mouse. Configure the guest to use Microsoft protocol.
 @end table
 ETEXI
 
-- 
1.6.2.5