Re: [Qemu-devel] [PATCH] qemu-options.hx: Remove confusing spaces in parameter listings

[Paolo Bonzini]

On 30/01/2018 10:36, Thomas Huth wrote:
> The spaces between the parameters in the chardev and tpmdev sections
> are rather confusing than helpful, and prevent that the lists can be
> copy-n-pasted easily for real usage. We also don't use such spaces
> in other sections in the documentation, e.g. with the -netdev option,
> so let's be consistent and remove the spaces in the chardev and tpmdev
> sections, too.
> 
> Signed-off-by: Thomas Huth <address@hidden>
> ---
>  qemu-options.hx | 48 ++++++++++++++++++++++++------------------------
>  1 file changed, 24 insertions(+), 24 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 8ce427d..08a73fa 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -2522,7 +2522,7 @@ STEXI
>  
>  The general form of a character device option is:
>  @table @option
> address@hidden -chardev @var{backend} ,address@hidden [,mux=on|off] 
> [,@var{options}]
> address@hidden -chardev 
> @var{backend},address@hidden,mux=on|off][,@var{options}]
>  @findex -chardev
>  Backend is one of:
>  @option{null},
> @@ -2541,7 +2541,7 @@ Backend is one of:
>  @option{tty},
>  @option{parallel},
>  @option{parport},
> address@hidden
> address@hidden,
>  @option{spiceport}.
>  The specific backend will determine the applicable options.
>  
> @@ -2605,11 +2605,11 @@ opened.
>  The available backends are:
>  
>  @table @option
> address@hidden -chardev null ,address@hidden
> address@hidden -chardev null,address@hidden
>  A void device. This device will not emit any data, and will drop any data it
>  receives. The null backend does not take any options.
>  
> address@hidden -chardev socket ,address@hidden address@hidden options} or 
> @var{unix options}] [,server] [,nowait] [,telnet] [,address@hidden 
> [,address@hidden
> address@hidden -chardev socket,address@hidden,@var{TCP options} or @var{unix 
> options}][,server][,nowait][,telnet][,address@hidden,address@hidden
>  
>  Create a two-way stream socket, which can be either a TCP or a unix socket. A
>  unix socket will be created if @option{path} is specified. Behaviour is
> @@ -2636,7 +2636,7 @@ TCP and unix socket options are given below:
>  
>  @table @option
>  
> address@hidden TCP options: address@hidden [,address@hidden [,address@hidden 
> [,ipv4] [,ipv6] [,nodelay]
> address@hidden TCP options: 
> address@hidden,address@hidden,address@hidden,ipv4][,ipv6][,nodelay]
>  
>  @option{host} for a listening socket specifies the local address to be bound.
>  For a connecting socket species the remote host to connect to. @option{host} 
> is
> @@ -2664,7 +2664,7 @@ required.
>  
>  @end table
>  
> address@hidden -chardev udp ,address@hidden [,address@hidden ,address@hidden 
> [,address@hidden [,address@hidden [,ipv4] [,ipv6]
> address@hidden -chardev 
> udp,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden,ipv4][,ipv6]
>  
>  Sends all traffic from the guest to a remote host over UDP.
>  
> @@ -2683,12 +2683,12 @@ available local port will be used.
>  @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be 
> used.
>  If neither is specified the device may use either protocol.
>  
> address@hidden -chardev msmouse ,address@hidden
> address@hidden -chardev msmouse,address@hidden
>  
>  Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does 
> not
>  take any options.
>  
> address@hidden -chardev vc ,address@hidden [[,address@hidden [,address@hidden 
> [[,address@hidden [,address@hidden
> address@hidden -chardev 
> vc,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
>  
>  Connect to a QEMU text console. @option{vc} may optionally be given a 
> specific
>  size.
> @@ -2699,12 +2699,12 @@ the console, in pixels.
>  @option{cols} and @option{rows} specify that the console be sized to fit a 
> text
>  console with the given dimensions.
>  
> address@hidden -chardev ringbuf ,address@hidden [,address@hidden
> address@hidden -chardev ringbuf,address@hidden,address@hidden
>  
>  Create a ring buffer with fixed size @option{size}.
>  @var{size} must be a power of two and defaults to @code{64K}.
>  
> address@hidden -chardev file ,address@hidden ,address@hidden
> address@hidden -chardev file,address@hidden,address@hidden
>  
>  Log all traffic received from the guest to a file.
>  
> @@ -2712,7 +2712,7 @@ Log all traffic received from the guest to a file.
>  created if it does not already exist, and overwritten if it does. 
> @option{path}
>  is required.
>  
> address@hidden -chardev pipe ,address@hidden ,address@hidden
> address@hidden -chardev pipe,address@hidden,address@hidden
>  
>  Create a two-way connection to the guest. The behaviour differs slightly 
> between
>  Windows hosts and other hosts:
> @@ -2729,14 +2729,14 @@ be present.
>  @option{path} forms part of the pipe path as described above. @option{path} 
> is
>  required.
>  
> address@hidden -chardev console ,address@hidden
> address@hidden -chardev console,address@hidden
>  
>  Send traffic from the guest to QEMU's standard output. @option{console} does 
> not
>  take any options.
>  
>  @option{console} is only available on Windows hosts.
>  
> address@hidden -chardev serial ,address@hidden ,address@hidden
> address@hidden -chardev serial,address@hidden,address@hidden
>  
>  Send traffic from the guest to a serial device on the host.
>  
> @@ -2745,33 +2745,33 @@ not only serial lines.
>  
>  @option{path} specifies the name of the serial device to open.
>  
> address@hidden -chardev pty ,address@hidden
> address@hidden -chardev pty,address@hidden
>  
>  Create a new pseudo-terminal on the host and connect to it. @option{pty} does
>  not take any options.
>  
>  @option{pty} is not available on Windows hosts.
>  
> address@hidden -chardev stdio ,address@hidden [,signal=on|off]
> address@hidden -chardev stdio,address@hidden,signal=on|off]
>  Connect to standard input and standard output of the QEMU process.
>  
>  @option{signal} controls if signals are enabled on the terminal, that 
> includes
>  exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
>  default, use @option{signal=off} to disable it.
>  
> address@hidden -chardev braille ,address@hidden
> address@hidden -chardev braille,address@hidden
>  
>  Connect to a local BrlAPI server. @option{braille} does not take any options.
>  
> address@hidden -chardev tty ,address@hidden ,address@hidden
> address@hidden -chardev tty,address@hidden,address@hidden
>  
>  @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
>  DragonFlyBSD hosts.  It is an alias for @option{serial}.
>  
>  @option{path} specifies the path to the tty. @option{path} is required.
>  
> address@hidden -chardev parallel ,address@hidden ,address@hidden
> address@hidden -chardev parport ,address@hidden ,address@hidden
> address@hidden -chardev parallel,address@hidden,address@hidden
> address@hidden -chardev parport,address@hidden,address@hidden
>  
>  @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
>  
> @@ -2780,7 +2780,7 @@ Connect to a local parallel port.
>  @option{path} specifies the path to the parallel port device. @option{path} 
> is
>  required.
>  
> address@hidden -chardev spicevmc ,address@hidden ,address@hidden, 
> address@hidden
> address@hidden -chardev spicevmc,address@hidden,address@hidden,address@hidden
>  
>  @option{spicevmc} is only available when spice support is built in.
>  
> @@ -2790,7 +2790,7 @@ required.
>  
>  Connect to a spice virtual machine channel, such as vdiport.
>  
> address@hidden -chardev spiceport ,address@hidden ,address@hidden, 
> address@hidden
> address@hidden -chardev spiceport,address@hidden,address@hidden,address@hidden
>  
>  @option{spiceport} is only available when spice support is built in.
>  
> @@ -2898,7 +2898,7 @@ STEXI
>  The general form of a TPM device option is:
>  @table @option
>  
> address@hidden -tpmdev @var{backend} ,address@hidden [,@var{options}]
> address@hidden -tpmdev @var{backend},address@hidden,@var{options}]
>  @findex -tpmdev
>  
>  The specific backend type will determine the applicable options.
> @@ -2913,7 +2913,7 @@ The available backends are:
>  
>  @table @option
>  
> address@hidden -tpmdev passthrough, address@hidden, address@hidden, 
> address@hidden
> address@hidden -tpmdev 
> passthrough,address@hidden,address@hidden,address@hidden
>  
>  (Linux-host only) Enable access to the host's TPM using the passthrough
>  driver.
> @@ -2950,7 +2950,7 @@ To create a passthrough TPM use the following two 
> options:
>  Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
>  @code{tpmdev=tpm0} in the device option.
>  
> address@hidden -tpmdev emulator, address@hidden, address@hidden
> address@hidden -tpmdev emulator,address@hidden,address@hidden
>  
>  (Linux-host only) Enable access to a TPM emulator using Unix domain socket 
> based
>  chardev backend.
> 

Reviewed-by: Paolo Bonzini <address@hidden>