From nobody Wed Nov 19 00:12:06 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1613502834; cv=none; d=zohomail.com; s=zohoarc; b=Rarfo8nBlBRVkC27K6FU+jUQLPtIKjddanXSDZu7NM6RftyyFnu8VkwgkDYC1mMIFacSkVndRIpsmSg6zh4DF1qPQNdrPCRRBcJxV9wEEBus6+Zqn5FtPjx1t0M4L7DXqsWMlu7O5V2dfdQMTeLxDxRQJqew7TCgu24KDNoDdeA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1613502834; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=7f3cF9FLPLfOmolQQ3RotNpTPiBGv5wPzbwCXGPIZOw=; b=AV8/7XV3wYLvNSigf5K1h87KIsj2ClsGKnYJPPdjMDfBbGHzfPbGOdG2rqXhDhZjnY15dWr7O4ZI+p/Edy2qGfsTBak5cT3NpB7qB5LVkXJG47TZL5/IHL72yGH6c4eZAtnEpsllnW/+OJ8FETIrQ9GC7tmetZRK+KehQviRy9s= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1613502834154464.4824825486728; Tue, 16 Feb 2021 11:13:54 -0800 (PST) Received: from localhost ([::1]:40810 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lC5nF-0004UE-3P for importer@patchew.org; Tue, 16 Feb 2021 14:13:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:45862) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lC5kE-0002fC-BI for qemu-devel@nongnu.org; Tue, 16 Feb 2021 14:10:46 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:55763) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1lC5kB-0004PN-L5 for qemu-devel@nongnu.org; Tue, 16 Feb 2021 14:10:46 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-388-rvVesU8NPb6xYR__JriovA-1; Tue, 16 Feb 2021 14:10:38 -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 mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1A4FCC287; Tue, 16 Feb 2021 19:10:37 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-215.ams2.redhat.com [10.36.112.215]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9DC485C1B4; Tue, 16 Feb 2021 19:10:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1613502642; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=7f3cF9FLPLfOmolQQ3RotNpTPiBGv5wPzbwCXGPIZOw=; b=C/UPRc3wxYtcAYKN2HGlerv7VQDx9Janiui8IrVY7FMFA6cRUoLF59OLG8QWy/+5KtgRs5 Z9LxPqF5n2PDbcWDt5jrQFlQzzUb0D1weOOCLnuDU0A/EJRdzZds+RAaF+Z+KLKettWnqr a+kV+mX3iSZ7RoRAYALtfa5vTV+gWJE= X-MC-Unique: rvVesU8NPb6xYR__JriovA-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH 02/10] qemu-options: update to show preferred boolean syntax for -chardev Date: Tue, 16 Feb 2021 19:10:19 +0000 Message-Id: <20210216191027.595031-3-berrange@redhat.com> In-Reply-To: <20210216191027.595031-1-berrange@redhat.com> References: <20210216191027.595031-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=berrange@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=63.128.21.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Paolo Bonzini Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) The preferred syntax is to use "foo=3Don|off", rather than a bare "foo" or "nofoo". Signed-off-by: Daniel P. Berrang=C3=A9 --- qemu-options.hx | 78 ++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 6c34c7050f..972ef412cc 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3032,13 +3032,13 @@ DEFHEADING(Character device options:) DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, "-chardev help\n" "-chardev null,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend=3Don= |off]\n" - "-chardev socket,id=3Did[,host=3Dhost],port=3Dport[,to=3Dto][,ipv4][,i= pv6][,nodelay][,reconnect=3Dseconds]\n" - " [,server][,nowait][,telnet][,websocket][,reconnect=3Dseconds= ][,mux=3Don|off]\n" + "-chardev socket,id=3Did[,host=3Dhost],port=3Dport[,to=3Dto][,ipv4=3Do= n|off][,ipv6=3Don|off][,delay=3Don|off][,reconnect=3Dseconds]\n" + " [,server=3Don|off][,wait=3Don|off][,telnet=3Don|off][,websoc= ket=3Don|off][,reconnect=3Dseconds][,mux=3Don|off]\n" " [,logfile=3DPATH][,logappend=3Don|off][,tls-creds=3DID][,tls= -authz=3DID] (tcp)\n" - "-chardev socket,id=3Did,path=3Dpath[,server][,nowait][,telnet][,webso= cket][,reconnect=3Dseconds]\n" + "-chardev socket,id=3Did,path=3Dpath[,server=3Don|off][,wait=3Don|off]= [,telnet=3Don|off][,websocket=3Don|off][,reconnect=3Dseconds]\n" " [,mux=3Don|off][,logfile=3DPATH][,logappend=3Don|off][,abstr= act=3Don|off][,tight=3Don|off] (unix)\n" "-chardev udp,id=3Did[,host=3Dhost],port=3Dport[,localaddr=3Dlocaladdr= ]\n" - " [,localport=3Dlocalport][,ipv4][,ipv6][,mux=3Don|off]\n" + " [,localport=3Dlocalport][,ipv4=3Don|off][,ipv6=3Don|off][,mu= x=3Don|off]\n" " [,logfile=3DPATH][,logappend=3Don|off]\n" "-chardev msmouse,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend= =3Don|off]\n" "-chardev vc,id=3Did[[,width=3Dwidth][,height=3Dheight]][[,cols=3Dcols= ][,rows=3Drows]]\n" @@ -3148,21 +3148,21 @@ The available backends are: 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 -``-chardev socket,id=3Did[,TCP options or unix options][,server][,nowait][= ,telnet][,websocket][,reconnect=3Dseconds][,tls-creds=3Did][,tls-authz=3Did= ]`` +``-chardev socket,id=3Did[,TCP options or unix options][,server=3Don|off][= ,wait=3Don|off][,telnet=3Don|off][,websocket=3Don|off][,reconnect=3Dseconds= ][,tls-creds=3Did][,tls-authz=3Did]`` Create a two-way stream socket, which can be either a TCP or a unix socket. A unix socket will be created if ``path`` is specified. Behaviour is undefined if TCP options are specified for a unix socket. =20 - ``server`` specifies that the socket shall be a listening socket. + ``server=3Don|off`` specifies that the socket shall be a listening soc= ket. =20 - ``nowait`` specifies that QEMU should not block waiting for a client + ``wait=3Don|off`` specifies that QEMU should not block waiting for a c= lient to connect to a listening socket. =20 - ``telnet`` specifies that traffic on the socket should interpret + ``telnet=3Don|off`` specifies that traffic on the socket should interp= ret telnet escape sequences. =20 - ``websocket`` specifies that the socket uses WebSocket protocol for + ``websocket=3Don|off`` specifies that the socket uses WebSocket protoc= ol for communication. =20 ``reconnect`` sets the timeout for reconnecting on non-server @@ -3183,7 +3183,7 @@ The available backends are: =20 TCP and unix socket options are given below: =20 - ``TCP options: port=3Dport[,host=3Dhost][,to=3Dto][,ipv4][,ipv6][,node= lay]`` + ``TCP options: port=3Dport[,host=3Dhost][,to=3Dto][,ipv4=3Don|off][,ip= v6=3Don|off][,delay=3Don|off]`` ``host`` for a listening socket specifies the local address to be bound. For a connecting socket species the remote host to connect to. ``host`` is optional for listening sockets. If not @@ -3199,21 +3199,21 @@ The available backends are: bind to subsequent ports up to and including ``to`` until it succeeds. ``to`` must be specified as a port number. =20 - ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be - used. If neither is specified the socket may use either - protocol. + ``ipv4=3Don|off`` and ``ipv6=3Don|off`` specify that either IPv4 + or IPv6 must be used. If neither is specified the socket may + use either protocol. =20 - ``nodelay`` disables the Nagle algorithm. + ``delay=3Don|off`` disables the Nagle algorithm. =20 ``unix options: path=3Dpath[,abstract=3Don|off][,tight=3Don|off]`` ``path`` specifies the local path of the unix socket. ``path`` is required. - ``abstract`` specifies the use of the abstract socket namespace, + ``abstract=3Don|off`` specifies the use of the abstract socket nam= espace, rather than the filesystem. Optional, defaults to false. - ``tight`` sets the socket length of abstract sockets to their mini= mum, + ``tight=3Don|off`` sets the socket length of abstract sockets to t= heir minimum, rather than the full sun_path length. Optional, defaults to true. =20 -``-chardev udp,id=3Did[,host=3Dhost],port=3Dport[,localaddr=3Dlocaladdr][,= localport=3Dlocalport][,ipv4][,ipv6]`` +``-chardev udp,id=3Did[,host=3Dhost],port=3Dport[,localaddr=3Dlocaladdr][,= localport=3Dlocalport][,ipv4=3Don|off][,ipv6=3Don|off]`` Sends all traffic from the guest to a remote host over UDP. =20 ``host`` specifies the remote host to connect to. If not specified @@ -3228,7 +3228,7 @@ The available backends are: ``localport`` specifies the local port to bind to. If not specified any available local port will be used. =20 - ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be used. + ``ipv4=3Don|off`` and ``ipv6=3Don|off`` specify that either IPv4 or IP= v6 must be used. If neither is specified the device may use either protocol. =20 ``-chardev msmouse,id=3Did`` @@ -3592,30 +3592,30 @@ SRST ``telnet options:`` localhost 5555 =20 - ``tcp:[host]:port[,server][,nowait][,nodelay][,reconnect=3Dseconds]`` + ``tcp:[host]:port[,server=3Don|off][,wait=3Don|off][,delay=3Don|off][,= reconnect=3Dseconds]`` The TCP Net Console has two modes of operation. It can send the serial I/O to a location or wait for a connection from a location. By default the TCP Net Console is sent to host at the - port. If you use the server option QEMU will wait for a client + port. If you use the ``server=3Don`` option QEMU will wait for a c= lient socket application to connect to the port before continuing, - unless the ``nowait`` option was specified. The ``nodelay`` - option disables the Nagle buffering algorithm. The ``reconnect`` - option only applies if noserver is set, if the connection goes + unless the ``wait=3Don|off`` option was specified. The ``delay=3Do= n|off`` + option disables the Nagle buffering algorithm. The ``reconnect=3Do= n`` + option only applies if ``server=3Dno`` is set, if the connection g= oes down it will attempt to reconnect at the given interval. If host is omitted, 0.0.0.0 is assumed. Only one TCP connection at a - time is accepted. You can use ``telnet`` to connect to the + time is accepted. You can use ``telnet=3Don`` to connect to the corresponding character device. =20 ``Example to send tcp console to 192.168.0.2 port 4444`` -serial tcp:192.168.0.2:4444 =20 ``Example to listen and wait on port 4444 for connection`` - -serial tcp::4444,server + -serial tcp::4444,server=3Don =20 ``Example to not wait and listen on ip 192.168.0.100 port 4444`` - -serial tcp:192.168.0.100:4444,server,nowait + -serial tcp:192.168.0.100:4444,server=3Don,wait=3Doff =20 - ``telnet:host:port[,server][,nowait][,nodelay]`` + ``telnet:host:port[,server=3Don|off][,wait=3Don|off][,delay=3Don|off]`` The telnet protocol is used instead of raw tcp sockets. The options work the same as if you had specified ``-serial tcp``. The difference is that the port acts like a telnet server or @@ -3625,11 +3625,11 @@ SRST you do it with Control-] and then type "send break" followed by pressing the enter key. =20 - ``websocket:host:port,server[,nowait][,nodelay]`` + ``websocket:host:port,server=3Don[,wait=3Don|off][,delay=3Don|off]`` The WebSocket protocol is used instead of raw tcp socket. The port acts as a WebSocket server. Client mode is not supported. =20 - ``unix:path[,server][,nowait][,reconnect=3Dseconds]`` + ``unix:path[,server=3Don|off][,wait=3Don|off][,reconnect=3Dseconds]`` A unix domain socket is used instead of a tcp socket. The option works the same as if you had specified ``-serial tcp`` except the unix domain socket path is used for connections. @@ -3642,7 +3642,7 @@ SRST multiplex the monitor onto a telnet server listening on port 4444 would be: =20 - ``-serial mon:telnet::4444,server,nowait`` + ``-serial mon:telnet::4444,server=3Don,wait=3Doff`` =20 When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate QEMU any more but will be passed to the guest @@ -4815,11 +4815,11 @@ SRST primary: -netdev tap,id=3Dhn0,vhost=3Doff,script=3D/etc/qemu-ifup,downs= cript=3D/etc/qemu-ifdown -device e1000,id=3De0,netdev=3Dhn0,mac=3D52:a4:00:12:78:66 - -chardev socket,id=3Dmirror0,host=3D3.3.3.3,port=3D9003,server= ,nowait - -chardev socket,id=3Dcompare1,host=3D3.3.3.3,port=3D9004,serve= r,nowait - -chardev socket,id=3Dcompare0,host=3D3.3.3.3,port=3D9001,serve= r,nowait + -chardev socket,id=3Dmirror0,host=3D3.3.3.3,port=3D9003,server= =3Don,wait=3Doff + -chardev socket,id=3Dcompare1,host=3D3.3.3.3,port=3D9004,serve= r=3Don,wait=3Doff + -chardev socket,id=3Dcompare0,host=3D3.3.3.3,port=3D9001,serve= r=3Don,wait=3Doff -chardev socket,id=3Dcompare0-0,host=3D3.3.3.3,port=3D9001 - -chardev socket,id=3Dcompare_out,host=3D3.3.3.3,port=3D9005,se= rver,nowait + -chardev socket,id=3Dcompare_out,host=3D3.3.3.3,port=3D9005,se= rver=3Don,wait=3Doff -chardev socket,id=3Dcompare_out0,host=3D3.3.3.3,port=3D9005 -object iothread,id=3Diothread1 -object filter-mirror,id=3Dm0,netdev=3Dhn0,queue=3Dtx,outdev= =3Dmirror0 @@ -4841,13 +4841,13 @@ SRST primary: -netdev tap,id=3Dhn0,vhost=3Doff,script=3D/etc/qemu-ifup,downs= cript=3D/etc/qemu-ifdown -device e1000,id=3De0,netdev=3Dhn0,mac=3D52:a4:00:12:78:66 - -chardev socket,id=3Dmirror0,host=3D3.3.3.3,port=3D9003,server= ,nowait - -chardev socket,id=3Dcompare1,host=3D3.3.3.3,port=3D9004,serve= r,nowait - -chardev socket,id=3Dcompare0,host=3D3.3.3.3,port=3D9001,serve= r,nowait + -chardev socket,id=3Dmirror0,host=3D3.3.3.3,port=3D9003,server= =3Don,wait=3Doff + -chardev socket,id=3Dcompare1,host=3D3.3.3.3,port=3D9004,serve= r=3Don,wait=3Doff + -chardev socket,id=3Dcompare0,host=3D3.3.3.3,port=3D9001,serve= r=3Don,wait=3Doff -chardev socket,id=3Dcompare0-0,host=3D3.3.3.3,port=3D9001 - -chardev socket,id=3Dcompare_out,host=3D3.3.3.3,port=3D9005,se= rver,nowait + -chardev socket,id=3Dcompare_out,host=3D3.3.3.3,port=3D9005,se= rver=3Don,wait=3Doff -chardev socket,id=3Dcompare_out0,host=3D3.3.3.3,port=3D9005 - -chardev socket,id=3Dnotify_way,host=3D3.3.3.3,port=3D9009,ser= ver,nowait + -chardev socket,id=3Dnotify_way,host=3D3.3.3.3,port=3D9009,ser= ver=3Don,wait=3Doff -object filter-mirror,id=3Dm0,netdev=3Dhn0,queue=3Dtx,outdev= =3Dmirror0 -object filter-redirector,netdev=3Dhn0,id=3Dredire0,queue=3Drx= ,indev=3Dcompare_out -object filter-redirector,netdev=3Dhn0,id=3Dredire1,queue=3Drx= ,outdev=3Dcompare0 --=20 2.29.2