From nobody Mon Apr 29 04:57:07 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1517305066094479.166723349726; Tue, 30 Jan 2018 01:37:46 -0800 (PST) Received: from localhost ([::1]:52713 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1egSME-0007aK-2s for importer@patchew.org; Tue, 30 Jan 2018 04:37:38 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:48134) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1egSL8-00078j-Fu for qemu-devel@nongnu.org; Tue, 30 Jan 2018 04:36:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1egSL3-0005kK-Fw for qemu-devel@nongnu.org; Tue, 30 Jan 2018 04:36:30 -0500 Received: from mx1.redhat.com ([209.132.183.28]:53132) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1egSL3-0005ic-8c; Tue, 30 Jan 2018 04:36:25 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id AD6D2690A; Tue, 30 Jan 2018 09:36:23 +0000 (UTC) Received: from thh440s.redhat.com (ovpn-116-136.ams2.redhat.com [10.36.116.136]) by smtp.corp.redhat.com (Postfix) with ESMTP id 69D6F5C3FA; Tue, 30 Jan 2018 09:36:22 +0000 (UTC) From: Thomas Huth To: qemu-devel@nongnu.org Date: Tue, 30 Jan 2018 10:36:21 +0100 Message-Id: <1517304981-28254-1-git-send-email-thuth@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.39]); Tue, 30 Jan 2018 09:36:23 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH] qemu-options.hx: Remove confusing spaces in parameter listings X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: qemu-trivial@nongnu.org, Paolo Bonzini , Stefan Berger Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" 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 Reviewed-by: Paolo Bonzini Reviewed-by: Stefan Berger --- 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 =20 The general form of a character device option is: @table @option -@item -chardev @var{backend} ,id=3D@var{id} [,mux=3Don|off] [,@var{options= }] +@item -chardev @var{backend},id=3D@var{id}[,mux=3Don|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}, -@option{spicevmc}. +@option{spicevmc}, @option{spiceport}. The specific backend will determine the applicable options. =20 @@ -2605,11 +2605,11 @@ opened. The available backends are: =20 @table @option -@item -chardev null ,id=3D@var{id} +@item -chardev null,id=3D@var{id} 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. =20 -@item -chardev socket ,id=3D@var{id} [@var{TCP options} or @var{unix optio= ns}] [,server] [,nowait] [,telnet] [,reconnect=3D@var{seconds}] [,tls-creds= =3D@var{id}] +@item -chardev socket,id=3D@var{id}[,@var{TCP options} or @var{unix option= s}][,server][,nowait][,telnet][,reconnect=3D@var{seconds}][,tls-creds=3D@va= r{id}] =20 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: =20 @table @option =20 -@item TCP options: port=3D@var{port} [,host=3D@var{host}] [,to=3D@var{to}]= [,ipv4] [,ipv6] [,nodelay] +@item TCP options: port=3D@var{port}[,host=3D@var{host}][,to=3D@var{to}][,= ipv4][,ipv6][,nodelay] =20 @option{host} for a listening socket specifies the local address to be bou= nd. For a connecting socket species the remote host to connect to. @option{hos= t} is @@ -2664,7 +2664,7 @@ required. =20 @end table =20 -@item -chardev udp ,id=3D@var{id} [,host=3D@var{host}] ,port=3D@var{port} = [,localaddr=3D@var{localaddr}] [,localport=3D@var{localport}] [,ipv4] [,ipv= 6] +@item -chardev udp,id=3D@var{id}[,host=3D@var{host}],port=3D@var{port}[,lo= caladdr=3D@var{localaddr}][,localport=3D@var{localport}][,ipv4][,ipv6] =20 Sends all traffic from the guest to a remote host over UDP. =20 @@ -2683,12 +2683,12 @@ available local port will be used. @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be u= sed. If neither is specified the device may use either protocol. =20 -@item -chardev msmouse ,id=3D@var{id} +@item -chardev msmouse,id=3D@var{id} =20 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does= not take any options. =20 -@item -chardev vc ,id=3D@var{id} [[,width=3D@var{width}] [,height=3D@var{h= eight}]] [[,cols=3D@var{cols}] [,rows=3D@var{rows}]] +@item -chardev vc,id=3D@var{id}[[,width=3D@var{width}][,height=3D@var{heig= ht}]][[,cols=3D@var{cols}][,rows=3D@var{rows}]] =20 Connect to a QEMU text console. @option{vc} may optionally be given a spec= ific 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. =20 -@item -chardev ringbuf ,id=3D@var{id} [,size=3D@var{size}] +@item -chardev ringbuf,id=3D@var{id}[,size=3D@var{size}] =20 Create a ring buffer with fixed size @option{size}. @var{size} must be a power of two and defaults to @code{64K}. =20 -@item -chardev file ,id=3D@var{id} ,path=3D@var{path} +@item -chardev file,id=3D@var{id},path=3D@var{path} =20 Log all traffic received from the guest to a file. =20 @@ -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. =20 -@item -chardev pipe ,id=3D@var{id} ,path=3D@var{path} +@item -chardev pipe,id=3D@var{id},path=3D@var{path} =20 Create a two-way connection to the guest. The behaviour differs slightly b= etween 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. =20 -@item -chardev console ,id=3D@var{id} +@item -chardev console,id=3D@var{id} =20 Send traffic from the guest to QEMU's standard output. @option{console} do= es not take any options. =20 @option{console} is only available on Windows hosts. =20 -@item -chardev serial ,id=3D@var{id} ,path=3D@option{path} +@item -chardev serial,id=3D@var{id},path=3D@option{path} =20 Send traffic from the guest to a serial device on the host. =20 @@ -2745,33 +2745,33 @@ not only serial lines. =20 @option{path} specifies the name of the serial device to open. =20 -@item -chardev pty ,id=3D@var{id} +@item -chardev pty,id=3D@var{id} =20 Create a new pseudo-terminal on the host and connect to it. @option{pty} d= oes not take any options. =20 @option{pty} is not available on Windows hosts. =20 -@item -chardev stdio ,id=3D@var{id} [,signal=3Don|off] +@item -chardev stdio,id=3D@var{id}[,signal=3Don|off] Connect to standard input and standard output of the QEMU process. =20 @option{signal} controls if signals are enabled on the terminal, that incl= udes exiting QEMU with the key sequence @key{Control-c}. This option is enabled= by default, use @option{signal=3Doff} to disable it. =20 -@item -chardev braille ,id=3D@var{id} +@item -chardev braille,id=3D@var{id} =20 Connect to a local BrlAPI server. @option{braille} does not take any optio= ns. =20 -@item -chardev tty ,id=3D@var{id} ,path=3D@var{path} +@item -chardev tty,id=3D@var{id},path=3D@var{path} =20 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and DragonFlyBSD hosts. It is an alias for @option{serial}. =20 @option{path} specifies the path to the tty. @option{path} is required. =20 -@item -chardev parallel ,id=3D@var{id} ,path=3D@var{path} -@itemx -chardev parport ,id=3D@var{id} ,path=3D@var{path} +@item -chardev parallel,id=3D@var{id},path=3D@var{path} +@itemx -chardev parport,id=3D@var{id},path=3D@var{path} =20 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hos= ts. =20 @@ -2780,7 +2780,7 @@ Connect to a local parallel port. @option{path} specifies the path to the parallel port device. @option{path= } is required. =20 -@item -chardev spicevmc ,id=3D@var{id} ,debug=3D@var{debug}, name=3D@var{n= ame} +@item -chardev spicevmc,id=3D@var{id},debug=3D@var{debug},name=3D@var{name} =20 @option{spicevmc} is only available when spice support is built in. =20 @@ -2790,7 +2790,7 @@ required. =20 Connect to a spice virtual machine channel, such as vdiport. =20 -@item -chardev spiceport ,id=3D@var{id} ,debug=3D@var{debug}, name=3D@var{= name} +@item -chardev spiceport,id=3D@var{id},debug=3D@var{debug},name=3D@var{nam= e} =20 @option{spiceport} is only available when spice support is built in. =20 @@ -2898,7 +2898,7 @@ STEXI The general form of a TPM device option is: @table @option =20 -@item -tpmdev @var{backend} ,id=3D@var{id} [,@var{options}] +@item -tpmdev @var{backend},id=3D@var{id}[,@var{options}] @findex -tpmdev =20 The specific backend type will determine the applicable options. @@ -2913,7 +2913,7 @@ The available backends are: =20 @table @option =20 -@item -tpmdev passthrough, id=3D@var{id}, path=3D@var{path}, cancel-path= =3D@var{cancel-path} +@item -tpmdev passthrough,id=3D@var{id},path=3D@var{path},cancel-path=3D@v= ar{cancel-path} =20 (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 opt= ions: Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by @code{tpmdev=3Dtpm0} in the device option. =20 -@item -tpmdev emulator, id=3D@var{id}, chardev=3D@var{dev} +@item -tpmdev emulator,id=3D@var{id},chardev=3D@var{dev} =20 (Linux-host only) Enable access to a TPM emulator using Unix domain socket= based chardev backend. --=20 1.8.3.1