From nobody Mon Feb 9 21:39:03 2026 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=1614327514; cv=none; d=zohomail.com; s=zohoarc; b=Mag8QzwjMtdRPdYW3EbES9LIsPO/j0o6iEvXaHGlnRcVA8kcCO6iDEWwDf3oJIk/Nl7XcTX87+HV8wtJ3mRG95qBqWNHOghJ3Fg8BrbGOGteGc+zvl+kGgvaIIj6n7ofEtmdOLFihIw/LSc05pkyyed4HAbD3UXH5ELBgt4CsPg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1614327514; 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=of0bpl2rGPvoAK4bpTeHOSzNLa0Pb2YOCS2cQuRXtyU=; b=Xnorq5SlJJS9ZepI++9FYjjEgdh5sQrKREHiYOq3DUixbPxNbFqpgsdCglLCbcE7yiITzkSD69YVD8n6b4ioBOCDJMQuBtfT0KiGIsJfVPsZZyx9q8lBKcjUKUBpuOpkn+LM4oaCqE2jBzC+ydZf7zIqPdYyAX+/A/cS0muolyU= 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 1614327514481686.5338603721906; Fri, 26 Feb 2021 00:18:34 -0800 (PST) Received: from localhost ([::1]:58856 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lFYKX-00064H-Da for importer@patchew.org; Fri, 26 Feb 2021 03:18:33 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:41804) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lFY87-0001pv-RK for qemu-devel@nongnu.org; Fri, 26 Feb 2021 03:05:45 -0500 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:36517) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lFY85-00049Z-1z for qemu-devel@nongnu.org; Fri, 26 Feb 2021 03:05:43 -0500 Received: by mail-wr1-x42e.google.com with SMTP id u14so7679042wri.3 for ; Fri, 26 Feb 2021 00:05:39 -0800 (PST) Received: from avogadro.lan ([2001:b07:6468:f312:c8dd:75d4:99ab:290a]) by smtp.gmail.com with ESMTPSA id n66sm10700830wmn.25.2021.02.26.00.05.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Feb 2021 00:05:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=of0bpl2rGPvoAK4bpTeHOSzNLa0Pb2YOCS2cQuRXtyU=; b=N3mgSLqUWOIC1HzXSsM5bBZS8//cgf8CER8Me5gcwyoX6cXFW396l0CLPMjoGS0/kp HEs6aQTB2u9Gttqkm0Wit2CBln4/A9E/Re7YB3utpNVGgIFp2FYtIBXcmK4WXoKQfl6R y8x2yvzwKqmYH+m76Iau2rcd5fZepQeKaL4DTJxPMpaR2c8QOE+98honMoImptLJTaaq iKqV8JIVWVJu8e8cBTdtV3KidT1cHl1zNvesUs1nA9iUK/gV0mJhicArWGHV+aX/ElVW BLrCBHz2nq4GQsiV5V+bbM9qz+xWLY2TW+Qg25NppJ9SxYZCpH4pXJn3Xi3zn3wSLHX/ NZWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=of0bpl2rGPvoAK4bpTeHOSzNLa0Pb2YOCS2cQuRXtyU=; b=Y5GAD0v8i1d6JcDB9l/7y39w9WNfT/jC6O8sG8VyzG9jwmB1/OOBui8eZY2zm48KOU 4dL1+/+XSTZRaGi27QdzgdXlCJe/t9cGunF2sWFdV9BL2pmA+mrRwjW0OpUXNup/rM4Q 928gD46GZtKYL97TXnUiPXzp4VJbr13rjsG1HIglrnAPYF7dYL6IA4pGCuUSaQPZPTVd JMUVkieOEQfoxjh76KMzcdbFYjP1CszfJXVoUcnA+WHpCyF38yS2oKjszWHA5KHcF10K DJBmbQsyAbJ5JDns0jUGahjTF50/0y2QESHstWsPDeE4z/bjc0BKPtM6eQv+q9leQ1pE 0JcQ== X-Gm-Message-State: AOAM530enLzxL2jZMu8zCHMgGYGopdzqzyXBUicCDF5gWiOb6iUWZeZX 56oFmVXBhXxtdRvorHXgpom7p4ZfMj4= X-Google-Smtp-Source: ABdhPJxwG9txx8zqEBfb+J7+Uihi+pyQn9SqqNxxz2LYpx8dQN4/IuvmAkMGAcEzqdPhRqR42a0zJw== X-Received: by 2002:a5d:4649:: with SMTP id j9mr1879357wrs.302.1614326738289; Fri, 26 Feb 2021 00:05:38 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PULL 16/29] qemu-options: update to show preferred boolean syntax for -chardev Date: Fri, 26 Feb 2021 09:05:13 +0100 Message-Id: <20210226080526.651705-17-pbonzini@redhat.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20210226080526.651705-1-pbonzini@redhat.com> References: <20210226080526.651705-1-pbonzini@redhat.com> MIME-Version: 1.0 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=2a00:1450:4864:20::42e; envelope-from=paolo.bonzini@gmail.com; helo=mail-wr1-x42e.google.com X-Spam_score_int: -14 X-Spam_score: -1.5 X-Spam_bar: - X-Spam_report: (-1.5 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) From: Daniel P. Berrang=C3=A9 The preferred syntax is to use "foo=3Don|off", rather than a bare "foo" or "nofoo". Signed-off-by: Daniel P. Berrang=C3=A9 Message-Id: <20210216191027.595031-3-berrange@redhat.com> Signed-off-by: Paolo Bonzini --- 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