From nobody Thu Nov 13 22:12:09 2025 Delivered-To: importer@patchew.org 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; Authentication-Results: mx.zohomail.com; dkim=pass; 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=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1582905138; cv=none; d=zohomail.com; s=zohoarc; b=dLC9Ze0Xp18cuuBYd3apjiXM8gEYNGtsoXG4dP9ogswO8prTWiHgXjYcpgj2Zfirz7XZzovCRJYjz/tcfu9tOA2tHcUDAtetM7fPaiGAAnIHSH1Q80QSu9XB6LINEIxh6HunN8z2Z+ASYHIlTBYU5kOynBpkr/B4EvZPhiM2ssE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1582905138; 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=FYTrVpOALtwqkrnK6qEPwtQXQqujjeEvIitUd9qckQ0=; b=PIzd+fYt7pVljCFIrbauQ4uMYtKPLC5ZKC8ChbiYPyVteQmdakGD2k+VSM/oyKvaiu3aySxjeR19ILfGeg7rRsMVYjWNesLEB+iHybzbn9FRrwEpD5sPye+qZmOLhDUBO4YOrT+yYdEcI0qCOqoB4s7BsHOiI1Kc1J8oDDsH3ko= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; 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=pass 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 1582905138923245.53132055270623; Fri, 28 Feb 2020 07:52:18 -0800 (PST) Received: from localhost ([::1]:49122 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j7hw1-0002rd-MI for importer@patchew.org; Fri, 28 Feb 2020 10:52:17 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:47018) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j7hhP-0001gI-Jw for qemu-devel@nongnu.org; Fri, 28 Feb 2020 10:37:13 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j7hhN-00058v-69 for qemu-devel@nongnu.org; Fri, 28 Feb 2020 10:37:11 -0500 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]:46787) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j7hhM-00058W-TL for qemu-devel@nongnu.org; Fri, 28 Feb 2020 10:37:09 -0500 Received: by mail-wr1-x442.google.com with SMTP id j7so3362197wrp.13 for ; Fri, 28 Feb 2020 07:37:08 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id u23sm2659452wmu.14.2020.02.28.07.37.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Feb 2020 07:37:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=9zS98jojjW/wRgYmUuBrHiH5zizpzM11D0PMyDODO0c=; b=EENfxSYPIWCAk3YaH5eZ1Iy+3HE1wo5tBrcRu7wdLkrC7xDHvSgoerRjae27kQ0mgW YSxZSwTUiIfMqGYJMFsUxHnYGaCdTGqkQ4cGNwS8Okp7/9K6PUI/8GjznG4AIOmlQbja C619dWObYu5HlZD44K5omV/Sima44w5vi4/21SgHmisVl96Bulkvz0H9wz9QHRlZSRXc cS6AQpf8anJpJ0uM91fXEHpSxnneQBHdtv87h3SB0X79P7CWFEZLnQzUfMUu8cxy1/ny YACtMHzfIkqd1GgQswAe/KMxsa5VKDRuo5bhTCdmYOmJmPJrlO0UDIN0OkmJTK7R2MBp 46MA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=9zS98jojjW/wRgYmUuBrHiH5zizpzM11D0PMyDODO0c=; b=kZ+xf1ncQY3nZNi7uCZZlLKR6BVAKK649h3VL437MYo8ZhYrb3T0YcCCLuqG8+eiSc pGSlGNasTr3mn2hLo+wH616glVbKHv1Yf5aXdbyPOEEka8C/E/l6eUhgMsZ0bYRMzRMm qH9JaWyTteALkpgPxN9WD9JMbSfe4664zm4BphB3h2VyHsEwNsWN51Uug3XKhSjX1izb sgUuB1gf378zFA6hmWrApgTPjYI4u/8xqlcsb6BhCaCacf7d6z23+rqxDuHsra8/ypFE Ang9cXBvYtBGjBc6P2zbP2CXPe5gE3nZh0N8oTlyxG//ZKUxZ5arcQF+nRo6MNLD+HH4 cF4Q== X-Gm-Message-State: APjAAAUtg5cPqTcAvOG/WUAa/XakcDwU6dEUFa8LeIr/eVUIejNduBn0 d+WvqAkYjUAOGwjmFDHgPHYWS1XSAouVfA== X-Google-Smtp-Source: APXvYqwdy4Wgf3hEwvdayYjOR3A911E2mQL9lRIiKXYvCWyC21c7S0u6lF7iSDTf9W5vQlk4kzoY0w== X-Received: by 2002:a5d:6891:: with SMTP id h17mr5217105wru.259.1582904227149; Fri, 28 Feb 2020 07:37:07 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST Date: Fri, 28 Feb 2020 15:36:13 +0000 Message-Id: <20200228153619.9906-28-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200228153619.9906-1-peter.maydell@linaro.org> References: <20200228153619.9906-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::442 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: Paolo Bonzini , Kashyap Chamarthy Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @linaro.org) This commit contains hand-written fixes for some issues with the autogenerated rST fragments in qemu-options.hx: * Sphinx complains about the UTF-8 art table in the documentation of the -drive option. Replace it with a proper rST format table. * rST does not like definition list entries with no actual definition, but it is possible to work around this by putting a single escaped literal space as the definition line. * The "-g widthxheight" option documentation suffers particularly badly from losing the distinction between italics and fixed-width as a result of the auto conversion, so put it back in again. * The script missed some places that use the |qemu_system| etc macros and need to be marked up as parsed-literal blocks. * The script autogenerated an expanded out version of the contents of qemu-option-trace.texi; replace it with an qemu-option-trace.rst.inc include. This is sufficient that we can enable inclusion of the option documentation from invocation.rst. Signed-off-by: Peter Maydell --- I opted not to try to reinstate all the italics-vs-fixed distinctions in the option headings, in the interests of expediency. I'm happy to go back and add this in later once the whole conversion has landed but I think we are better off doing a mostly-good-enough conversion quickly and then refining it in-tree rather than having it out of tree for a long time and getting hit by problems as documentation is updated by other patches... --- Makefile | 2 +- docs/system/invocation.rst | 2 + qemu-options.hx | 143 +++++++++++++++++++++---------------- 3 files changed, 84 insertions(+), 63 deletions(-) diff --git a/Makefile b/Makefile index 98ef06ab8e8..f7d08997dbf 100644 --- a/Makefile +++ b/Makefile @@ -1071,7 +1071,7 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-= deps,interop) $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(call build-manual,specs,html) =20 -$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PAT= H)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx +$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PAT= H)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/qemu-option= s.hx $(call build-manual,system,html) =20 $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)= /qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst index c112bcb45a4..d77dd13d4f7 100644 --- a/docs/system/invocation.rst +++ b/docs/system/invocation.rst @@ -10,6 +10,8 @@ Invocation disk_image is a raw hard disk image for IDE hard disk 0. Some targets do not need a disk image. =20 +.. hxtool-doc:: qemu-options.hx + Device URL Syntax ~~~~~~~~~~~~~~~~~ =20 diff --git a/qemu-options.hx b/qemu-options.hx index 043e425b61e..f7061212ceb 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -448,7 +448,17 @@ cache, size is 10KB, policy is write-back, the cache L= ine size is 8 bytes: =20 ETEXI SRST -``-numa node[,mem=3Dsize][,cpus=3Dfirstcpu[-lastcpu]][,nodeid=3Dnode][,ini= tiator=3Dinitiator]``; \ ``-numa node[,memdev=3Did][,cpus=3Dfirstcpu[-lastc= pu]][,nodeid=3Dnode][,initiator=3Dinitiator]``; \ ``-numa dist,src=3Dsource= ,dst=3Ddestination,val=3Ddistance``; \ ``-numa cpu,node-id=3Dnode[,socket-i= d=3Dx][,core-id=3Dy][,thread-id=3Dz]``; \ ``-numa hmat-lb,initiator=3Dnode,= target=3Dnode,hierarchy=3Dhierarchy,data-type=3Dtpye[,latency=3Dlat][,bandw= idth=3Dbw]``; \ ``-numa hmat-cache,node-id=3Dnode,size=3Dsize,level=3Dlevel= [,associativity=3Dstr][,policy=3Dstr][,line=3Dsize]`` +``-numa node[,mem=3Dsize][,cpus=3Dfirstcpu[-lastcpu]][,nodeid=3Dnode][,ini= tiator=3Dinitiator]`` + \=20 +``-numa node[,memdev=3Did][,cpus=3Dfirstcpu[-lastcpu]][,nodeid=3Dnode][,in= itiator=3Dinitiator]`` + \ +``-numa dist,src=3Dsource,dst=3Ddestination,val=3Ddistance`` + \=20 +``-numa cpu,node-id=3Dnode[,socket-id=3Dx][,core-id=3Dy][,thread-id=3Dz]`` + \=20 +``-numa hmat-lb,initiator=3Dnode,target=3Dnode,hierarchy=3Dhierarchy,data-= type=3Dtpye[,latency=3Dlat][,bandwidth=3Dbw]`` + \=20 +``-numa hmat-cache,node-id=3Dnode,size=3Dsize,level=3Dlevel[,associativity= =3Dstr][,policy=3Dstr][,line=3Dsize]`` Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA distance from a source node to a destination node. Set the ACPI Heterogeneous Memory Attributes for the given nodes. @@ -687,7 +697,9 @@ driver=3D@var{driver},property=3D@var{prop},value=3D@va= r{value}. The longhand syntax works even when @var{driver} contains a dot. ETEXI SRST -``-global driver.prop=3Dvalue``; \ ``-global driver=3Ddriver,property=3Dpr= operty,value=3Dvalue`` +``-global driver.prop=3Dvalue`` + \=20 +``-global driver=3Ddriver,property=3Dproperty,value=3Dvalue`` Set default value of driver's property prop to value, e.g.: =20 .. parsed-literal:: @@ -788,7 +800,7 @@ SRST it. This only effects when boot priority is changed by bootindex options. The default is non-strict boot. =20 - :: + .. parsed-literal:: =20 # try to boot from network first, then from hard disk |qemu_system_x86| -boot order=3Dnc @@ -1618,7 +1630,9 @@ STEXI Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). ETEXI SRST -``-fda file``; \ ``-fdb file`` +``-fda file`` + \ +``-fdb file`` Use file as floppy disk 0/1 image (see :ref:`disk_005fimages`). ERST @@ -1641,7 +1655,13 @@ STEXI Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). ETEXI SRST -``-hda file``; \ ``-hdb file``; \ ``-hdc file``; \ ``-hdd file`` +``-hda file`` + \ +``-hdb file`` + \=20 +``-hdc file`` + \=20 +``-hdd file`` Use file as hard disk 0, 1, 2 or 3 image (see :ref:`disk_005fimages`). ERST @@ -2295,15 +2315,15 @@ SRST the ``write-cache`` option of block guest devices (as in ``-device``). The modes correspond to the following settings: =20 - :: - - =EF=BF=BD =E2=94=82 cache.writeback cache.direct = cache.no-flush - =E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94= =80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=BC=E2=94=80= =E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2= =94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94= =80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80= =E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2= =94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94= =80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80=E2=94=80 - writeback =E2=94=82 on off off - none =E2=94=82 on on off - writethrough =E2=94=82 off off off - directsync =E2=94=82 off on off - unsafe =E2=94=82 on off on + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + \ cache.writeback cache.direct cache.no-flush + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + writeback on off off + none on on off + writethrough off off off + directsync off on off + unsafe on off on + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 The default mode is ``cache=3Dwriteback``. =20 @@ -2594,7 +2614,13 @@ Specifies the tag name to be used by the guest to mo= unt this export point. =20 ETEXI SRST -``-fsdev local,id=3Did,path=3Dpath,security_model=3Dsecurity_model [,write= out=3Dwriteout][,readonly][,fmode=3Dfmode][,dmode=3Ddmode] [,throttling.opt= ion=3Dvalue[,throttling.option=3Dvalue[,...]]]``; \ ``-fsdev proxy,id=3Did,= socket=3Dsocket[,writeout=3Dwriteout][,readonly]``; \ ``-fsdev proxy,id=3Di= d,sock_fd=3Dsock_fd[,writeout=3Dwriteout][,readonly]``; \ ``-fsdev synth,id= =3Did[,readonly]`` +``-fsdev local,id=3Did,path=3Dpath,security_model=3Dsecurity_model [,write= out=3Dwriteout][,readonly][,fmode=3Dfmode][,dmode=3Ddmode] [,throttling.opt= ion=3Dvalue[,throttling.option=3Dvalue[,...]]]`` + \=20 +``-fsdev proxy,id=3Did,socket=3Dsocket[,writeout=3Dwriteout][,readonly]`` + \ +``-fsdev proxy,id=3Did,sock_fd=3Dsock_fd[,writeout=3Dwriteout][,readonly]`` + \ +``-fsdev synth,id=3Did[,readonly]`` Define a new file system device. Valid options are: =20 ``local`` @@ -2791,7 +2817,13 @@ would still return entries from other devices). @end table ETEXI SRST -``-virtfs local,path=3Dpath,mount_tag=3Dmount_tag ,security_model=3Dsecuri= ty_model[,writeout=3Dwriteout][,readonly] [,fmode=3Dfmode][,dmode=3Ddmode][= ,multidevs=3Dmultidevs]``; \ ``-virtfs proxy,socket=3Dsocket,mount_tag=3Dmo= unt_tag [,writeout=3Dwriteout][,readonly]``; \ ``-virtfs proxy,sock_fd=3Dso= ck_fd,mount_tag=3Dmount_tag [,writeout=3Dwriteout][,readonly]``; \ ``-virtf= s synth,mount_tag=3Dmount_tag`` +``-virtfs local,path=3Dpath,mount_tag=3Dmount_tag ,security_model=3Dsecuri= ty_model[,writeout=3Dwriteout][,readonly] [,fmode=3Dfmode][,dmode=3Ddmode][= ,multidevs=3Dmultidevs]`` + \=20 +``-virtfs proxy,socket=3Dsocket,mount_tag=3Dmount_tag [,writeout=3Dwriteou= t][,readonly]`` + \=20 +``-virtfs proxy,sock_fd=3Dsock_fd,mount_tag=3Dmount_tag [,writeout=3Dwrite= out][,readonly]`` + \ +``-virtfs synth,mount_tag=3Dmount_tag`` Define a new filesystem device and expose it to the guest using a virtio-9p-device. The general form of a Virtual File system pass-through options are: @@ -3568,7 +3600,7 @@ of 1152x900x8 for people who wish to use OBP. =20 ETEXI SRST -``-g widthxheight[xdepth]`` +``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` Set the initial graphical resolution and depth (PPC, SPARC only). =20 For PPC the default is 800x600x32. @@ -4847,7 +4879,7 @@ SRST For example, to redirect host X11 connection from screen 1 to guest screen 0, use the following: =20 - :: + .. parsed-literal:: =20 # on the host |qemu_system| -nic user,hostfwd=3Dtcp:127.0.0.1:6001-:6000 @@ -4857,7 +4889,7 @@ SRST To redirect telnet connections from host port 5555 to telnet port on the guest, use the following: =20 - :: + .. parsed-literal:: =20 # on the host |qemu_system| -nic user,hostfwd=3Dtcp::5555-:23 @@ -4875,7 +4907,7 @@ SRST You can either use a chardev directly and have that one used throughout QEMU's lifetime, like in the following example: =20 - :: + .. parsed-literal:: =20 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it= whenever # the guest accesses it @@ -4885,7 +4917,7 @@ SRST by the guest, so that QEMU behaves similar to an inetd process for that virtual server: =20 - :: + .. parsed-literal:: =20 # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0= .2.100:1234 # and connect the TCP stream to its stdin/stdout @@ -4912,12 +4944,12 @@ SRST =20 Examples: =20 - :: + .. parsed-literal:: =20 #launch a QEMU instance with the default network script |qemu_system| linux.img -nic tap =20 - :: + .. parsed-literal:: =20 #launch a QEMU instance with two NICs, each one connected #to a TAP device @@ -4925,7 +4957,7 @@ SRST -netdev tap,id=3Dnd0,ifname=3Dtap0 -device e1000,netdev=3D= nd0 \ -netdev tap,id=3Dnd1,ifname=3Dtap1 -device rtl8139,netdev= =3Dnd1 =20 - :: + .. parsed-literal:: =20 #launch a QEMU instance with the default network helper to #connect a TAP device to bridge br0 @@ -4942,13 +4974,13 @@ SRST =20 Examples: =20 - :: + .. parsed-literal:: =20 #launch a QEMU instance with the default network helper to #connect a TAP device to bridge br0 |qemu_system| linux.img -netdev bridge,id=3Dn1 -device virtio-net,= netdev=3Dn1 =20 - :: + .. parsed-literal:: =20 #launch a QEMU instance with the default network helper to #connect a TAP device to bridge qemubr0 @@ -4964,7 +4996,7 @@ SRST =20 Example: =20 - :: + .. parsed-literal:: =20 # launch a first QEMU instance |qemu_system| linux.img \ @@ -4991,7 +5023,7 @@ SRST =20 Example: =20 - :: + .. parsed-literal:: =20 # launch one QEMU instance |qemu_system| linux.img \ @@ -5008,7 +5040,7 @@ SRST =20 Example (User Mode Linux compat.): =20 - :: + .. parsed-literal:: =20 # launch QEMU instance (note mcast address selected is UML's defau= lt) |qemu_system| linux.img \ @@ -5074,7 +5106,7 @@ SRST For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan on the remote Linux host 1.2.3.4: =20 - :: + .. parsed-literal:: =20 # Setup tunnel on linux host using raw ip as encapsulation # on 1.2.3.4 @@ -5102,7 +5134,7 @@ SRST =20 Example: =20 - :: + .. parsed-literal:: =20 # launch vde switch vde_switch -F -sock /tmp/myswitch @@ -5731,7 +5763,9 @@ The available backends are: =20 ``path`` specifies the path to the tty. ``path`` is required. =20 -``-chardev parallel,id=3Did,path=3Dpath``; \ ``-chardev parport,id=3Did,pa= th=3Dpath`` +``-chardev parallel,id=3Did,path=3Dpath`` + \ +``-chardev parport,id=3Did,path=3Dpath`` ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD hosts. =20 @@ -6569,6 +6603,7 @@ utilization will be incorrect, not taking into accoun= t guest idle time. ETEXI SRST ``-overcommit mem-lock=3Don|off`` + \=20 ``-overcommit cpu-pm=3Don|off`` Run qemu with hints about host resource overcommit. The default is to assume that host overcommits all resources. @@ -6607,7 +6642,7 @@ SRST use case. The latter is allowing to start QEMU from within gdb and establish the connection via a pipe: =20 - :: + .. parsed-literal:: =20 (gdb) target remote | exec |qemu_system| -gdb stdio ... ERST @@ -7196,7 +7231,9 @@ be used to change settings (such as migration paramet= ers) prior to issuing the migrate_incoming to allow the migration to begin. ETEXI SRST -``-incoming tcp:[host]:port[,to=3Dmaxport][,ipv4][,ipv6]``; \ ``-incoming = rdma:host:port[,ipv4][,ipv6]`` +``-incoming tcp:[host]:port[,to=3Dmaxport][,ipv4][,ipv6]`` + \=20 +``-incoming rdma:host:port[,ipv4][,ipv6]`` Prepare for incoming migration, listen on a given tcp port. =20 ``-incoming unix:socketpath`` @@ -7537,27 +7574,8 @@ HXCOMM HX does not support conditional compilation o= f text. ETEXI SRST ``-trace [[enable=3D]pattern][,events=3Dfile][,file=3Dfile]`` - Specify tracing options. + .. include:: ../qemu-option-trace.rst.inc =20 - ``[enable=3D]pattern`` - Immediately enable events matching pattern (either event name or - a globbing pattern). This option is only available if QEMU has - been compiled with the simple, log or ftrace tracing backend. To - specify multiple events or patterns, specify the ``-trace`` - option multiple times. - - Use ``-trace help`` to print a list of names of trace points. - - ``events=3Dfile`` - Immediately enable events listed in file. The file must contain - one event name (as listed in the ``trace-events-all`` file) per - line; globbing patterns are accepted too. This option is only - available if QEMU has been compiled with the simple, log or - ftrace tracing backend. - - ``file=3Dfile`` - Log output traces to file. This option is only available if QEMU - has been compiled with the simple tracing backend. ERST DEF("plugin", HAS_ARG, QEMU_OPTION_plugin, "-plugin [file=3D][,arg=3D]\n" @@ -8707,7 +8725,7 @@ SRST which specify the queue number of cryptodev backend, the default of queues is 1. =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ [...] \ @@ -8726,7 +8744,7 @@ SRST specify the queue number of cryptodev backend for multiqueue vhost-user, the default of queues is 1. =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ [...] \ @@ -8736,6 +8754,7 @@ SRST [...] =20 ``-object secret,id=3Did,data=3Dstring,format=3Draw|base64[,keyid=3Dse= cretid,iv=3Dstring]`` + \=20 ``-object secret,id=3Did,file=3Dfilename,format=3Draw|base64[,keyid=3D= secretid,iv=3Dstring]`` Defines a secret to store a password, encryption key, or some other sensitive data. The sensitive data can either be passed @@ -8763,7 +8782,7 @@ SRST =20 The simplest (insecure) usage is to provide the secret inline =20 - :: + .. parsed-literal:: =20 # |qemu_system| -object secret,id=3Dsec0,data=3Dletmein,forma= t=3Draw =20 @@ -8807,7 +8826,7 @@ SRST ``key.b64`` and specify that to be used to decrypt the user password. Pass the contents of ``iv.b64`` to the second secret =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ -object secret,id=3Dsecmaster0,format=3Dbase64,file=3Dkey= .b64 \ @@ -8856,7 +8875,7 @@ SRST =20 e.g to launch a SEV guest =20 - :: + .. parsed-literal:: =20 # |qemu_system_x86| \ ...... @@ -8877,7 +8896,7 @@ SRST An example authorization object to validate a x509 distinguished name would look like: =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ ... @@ -8928,7 +8947,7 @@ SRST An example authorization object to validate a SASL username would look like: =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ ... @@ -8947,7 +8966,7 @@ SRST An example authorization object to validate a TLS x509 distinguished name would look like: =20 - :: + .. parsed-literal:: =20 # |qemu_system| \ ... --=20 2.20.1