From c23874132b79f69328b53273437970116c7a3d0d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Daniel=20P=2E=20Berrang=C3=A9?= Date: Tue, 16 Feb 2021 19:10:24 +0000 Subject: [PATCH] docs: update to show preferred boolean syntax for -chardev MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit The preferred syntax is to use "foo=on|off", rather than a bare "foo" or "nofoo". Signed-off-by: Daniel P. Berrangé Message-Id: <20210216191027.595031-8-berrange@redhat.com> Signed-off-by: Paolo Bonzini --- docs/COLO-FT.txt | 8 ++++---- docs/ccid.txt | 6 ++++-- docs/colo-proxy.txt | 16 ++++++++-------- docs/devel/writing-qmp-commands.txt | 2 +- docs/interop/live-block-operations.rst | 4 ++-- docs/interop/qmp-intro.txt | 4 ++-- docs/system/cpu-hotplug.rst | 2 +- docs/system/s390x/3270.rst | 2 +- docs/system/target-avr.rst | 2 +- docs/tools/qemu-storage-daemon.rst | 4 ++-- scripts/qmp/qemu-ga-client | 2 +- tests/test-char.c | 4 ++-- 12 files changed, 29 insertions(+), 27 deletions(-) diff --git a/docs/COLO-FT.txt b/docs/COLO-FT.txt index bc5fb2a1bb..8874690e83 100644 --- a/docs/COLO-FT.txt +++ b/docs/COLO-FT.txt @@ -162,11 +162,11 @@ instance. -device piix3-usb-uhci -device usb-tablet -name primary \ -netdev tap,id=hn0,vhost=off,helper=/usr/lib/qemu/qemu-bridge-helper \ -device rtl8139,id=e0,netdev=hn0 \ - -chardev socket,id=mirror0,host=0.0.0.0,port=9003,server,nowait \ - -chardev socket,id=compare1,host=0.0.0.0,port=9004,server,wait \ - -chardev socket,id=compare0,host=127.0.0.1,port=9001,server,nowait \ + -chardev socket,id=mirror0,host=0.0.0.0,port=9003,server=on,wait=off \ + -chardev socket,id=compare1,host=0.0.0.0,port=9004,server=on,wait=on \ + -chardev socket,id=compare0,host=127.0.0.1,port=9001,server=on,wait=off \ -chardev socket,id=compare0-0,host=127.0.0.1,port=9001 \ - -chardev socket,id=compare_out,host=127.0.0.1,port=9005,server,nowait \ + -chardev socket,id=compare_out,host=127.0.0.1,port=9005,server=on,wait=off \ -chardev socket,id=compare_out0,host=127.0.0.1,port=9005 \ -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 \ -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out \ diff --git a/docs/ccid.txt b/docs/ccid.txt index c7fda6d07d..c97fbd2de0 100644 --- a/docs/ccid.txt +++ b/docs/ccid.txt @@ -109,7 +109,8 @@ NSS. Registration can be done from Firefox or the command line: on the host specify the ccid-card-passthru device with a suitable chardev: - qemu -chardev socket,server,host=0.0.0.0,port=2001,id=ccid,nowait -usb -device usb-ccid -device ccid-card-passthru,chardev=ccid + qemu -chardev socket,server=on,host=0.0.0.0,port=2001,id=ccid,wait=off \ + -usb -device usb-ccid -device ccid-card-passthru,chardev=ccid on the client run vscclient, built when you built QEMU: @@ -125,7 +126,8 @@ Follow instructions as per #4, except run QEMU and vscclient as follows: Run qemu as per #5, and run vscclient from the "fake-smartcard" directory as follows: - qemu -chardev socket,server,host=0.0.0.0,port=2001,id=ccid,nowait -usb -device usb-ccid -device ccid-card-passthru,chardev=ccid + qemu -chardev socket,server=on,host=0.0.0.0,port=2001,id=ccid,wait=off \ + -usb -device usb-ccid -device ccid-card-passthru,chardev=ccid vscclient -e "db=\"sql:$PWD\" use_hw=no soft=(,Test,CAC,,id-cert,signing-cert,encryption-cert)" 2001 diff --git a/docs/colo-proxy.txt b/docs/colo-proxy.txt index fa1cef0278..1fc38aed1b 100644 --- a/docs/colo-proxy.txt +++ b/docs/colo-proxy.txt @@ -164,11 +164,11 @@ clearly describe the usage. Primary(ip:3.3.3.3): -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 --chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait --chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait --chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait +-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off +-chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off +-chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 --chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait +-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 -object iothread,id=iothread1 -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 @@ -190,11 +190,11 @@ If you want to use virtio-net-pci or other driver with vnet_header: Primary(ip:3.3.3.3): -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 --chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait --chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait --chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait +-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off +-chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off +-chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 --chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait +-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0,vnet_hdr_support -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out,vnet_hdr_support diff --git a/docs/devel/writing-qmp-commands.txt b/docs/devel/writing-qmp-commands.txt index 258e63bff5..b1e31d56c0 100644 --- a/docs/devel/writing-qmp-commands.txt +++ b/docs/devel/writing-qmp-commands.txt @@ -39,7 +39,7 @@ shown here. First, QEMU should be started like this: # qemu-system-TARGET [...] \ - -chardev socket,id=qmp,port=4444,host=localhost,server \ + -chardev socket,id=qmp,port=4444,host=localhost,server=on \ -mon chardev=qmp,mode=control,pretty=on Then, in a different terminal: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-operations.rst index e13f5a21f8..1073b930dc 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -133,7 +133,7 @@ socket:: -M q35 -nodefaults -m 512 \ -blockdev node-name=node-A,driver=qcow2,file.driver=file,file.node-name=file,file.filename=./a.qcow2 \ -device virtio-blk,drive=node-A,id=virtio0 \ - -monitor stdio -qmp unix:/tmp/qmp-sock,server,nowait + -monitor stdio -qmp unix:/tmp/qmp-sock,server=on,wait=off The ``-blockdev`` command-line option, used above, is available from QEMU 2.9 onwards. In the above invocation, notice the ``node-name`` @@ -698,7 +698,7 @@ it could be located elsewhere):: -M q35 -nodefaults -m 512 \ -blockdev node-name=node-TargetDisk,driver=qcow2,file.driver=file,file.node-name=file,file.filename=./target-disk.qcow2 \ -device virtio-blk,drive=node-TargetDisk,id=virtio0 \ - -S -monitor stdio -qmp unix:./qmp-sock2,server,nowait \ + -S -monitor stdio -qmp unix:./qmp-sock2,server=on,wait=off \ -incoming tcp:localhost:6666 Given the disk image chain on source QEMU:: diff --git a/docs/interop/qmp-intro.txt b/docs/interop/qmp-intro.txt index 9d54a718b8..1c745a7af0 100644 --- a/docs/interop/qmp-intro.txt +++ b/docs/interop/qmp-intro.txt @@ -26,7 +26,7 @@ Usage You can use the -qmp option to enable QMP. For example, the following makes QMP available on localhost port 4444: -$ qemu [...] -qmp tcp:localhost:4444,server,nowait +$ qemu [...] -qmp tcp:localhost:4444,server=on,wait=off However, for more flexibility and to make use of more options, the -mon command-line option should be used. For instance, the following example @@ -34,7 +34,7 @@ creates one HMP instance (human monitor) on stdio and one QMP instance on localhost port 4444: $ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \ - -chardev socket,id=mon1,host=localhost,port=4444,server,nowait \ + -chardev socket,id=mon1,host=localhost,port=4444,server=on,wait=off \ -mon chardev=mon1,mode=control,pretty=on Please, refer to QEMU's manpage for more information. diff --git a/docs/system/cpu-hotplug.rst b/docs/system/cpu-hotplug.rst index d0b06403f1..bd0663616e 100644 --- a/docs/system/cpu-hotplug.rst +++ b/docs/system/cpu-hotplug.rst @@ -14,7 +14,7 @@ vCPU hotplug $ qemu-system-x86_64 -display none -no-user-config -m 2048 \ -nodefaults -monitor stdio -machine pc,accel=kvm,usb=off \ -smp 1,maxcpus=2 -cpu IvyBridge-IBRS \ - -qmp unix:/tmp/qmp-sock,server,nowait + -qmp unix:/tmp/qmp-sock,server=on,wait=off (2) Run 'qmp-shell' (located in the source tree, under: "scripts/qmp/) to connect to the just-launched QEMU:: diff --git a/docs/system/s390x/3270.rst b/docs/system/s390x/3270.rst index 0554a70a9f..0e173b323f 100644 --- a/docs/system/s390x/3270.rst +++ b/docs/system/s390x/3270.rst @@ -24,7 +24,7 @@ Example configuration * Add a ``tn3270`` chardev and a ``x-terminal3270`` to the QEMU command line:: - -chardev socket,id=ch0,host=0.0.0.0,port=2300,nowait,server,tn3270 + -chardev socket,id=ch0,host=0.0.0.0,port=2300,wait=off,server=on,tn3270=on -device x-terminal3270,chardev=ch0,devno=fe.0.000a,id=terminal0 * Start the guest. In the guest, use ``chccwdev -e 0.0.000a`` to enable diff --git a/docs/system/target-avr.rst b/docs/system/target-avr.rst index 25ab46ef05..03d5ab51c1 100644 --- a/docs/system/target-avr.rst +++ b/docs/system/target-avr.rst @@ -24,7 +24,7 @@ AVR cpu - Continuous non interrupted execution with serial output into telnet window:: qemu-system-avr -M mega2560 -bios demo.elf -nographic \ - -serial tcp::5678,server,nowait + -serial tcp::5678,server=on,wait=off and then in another shell:: diff --git a/docs/tools/qemu-storage-daemon.rst b/docs/tools/qemu-storage-daemon.rst index f63627eaf6..c05b3d3811 100644 --- a/docs/tools/qemu-storage-daemon.rst +++ b/docs/tools/qemu-storage-daemon.rst @@ -69,7 +69,7 @@ Standard options: a description of character device properties. A common character device definition configures a UNIX domain socket:: - --chardev socket,id=char1,path=/tmp/qmp.sock,server,nowait + --chardev socket,id=char1,path=/tmp/qmp.sock,server=on,wait=off .. option:: --export [type=]nbd,id=,node-name=[,name=][,writable=on|off][,bitmap=] --export [type=]vhost-user-blk,id=,node-name=,addr.type=unix,addr.path=[,writable=on|off][,logical-block-size=][,num-queues=] @@ -124,7 +124,7 @@ Launch the daemon with QMP monitor socket ``qmp.sock`` so clients can execute QMP commands:: $ qemu-storage-daemon \ - --chardev socket,path=qmp.sock,server,nowait,id=char1 \ + --chardev socket,path=qmp.sock,server=on,wait=off,id=char1 \ --monitor chardev=char1 Export raw image file ``disk.img`` over NBD UNIX domain socket ``nbd.sock``:: diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client index ce122984a9..348d85864c 100755 --- a/scripts/qmp/qemu-ga-client +++ b/scripts/qmp/qemu-ga-client @@ -11,7 +11,7 @@ # # Start QEMU with: # -# # qemu [...] -chardev socket,path=/tmp/qga.sock,server,nowait,id=qga0 \ +# # qemu [...] -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \ # -device virtio-serial -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0 # # Run the script: diff --git a/tests/test-char.c b/tests/test-char.c index 469d25989c..755d54c15e 100644 --- a/tests/test-char.c +++ b/tests/test-char.c @@ -780,7 +780,7 @@ static void char_socket_server_test(gconstpointer opaque) g_setenv("QTEST_SILENT_ERRORS", "1", 1); /* - * We rely on config->addr containing "nowait", otherwise + * We rely on config->addr containing "wait=off", otherwise * qemu_chr_new() will block until a client connects. We * can't spawn our client thread though, because until * qemu_chr_new() returns we don't know what TCP port was @@ -1114,7 +1114,7 @@ static void char_socket_server_two_clients_test(gconstpointer opaque) g_setenv("QTEST_SILENT_ERRORS", "1", 1); /* - * We rely on addr containing "nowait", otherwise + * We rely on addr containing "wait=off", otherwise * qemu_chr_new() will block until a client connects. We * can't spawn our client thread though, because until * qemu_chr_new() returns we don't know what TCP port was -- 2.11.4.GIT