From nobody Fri May 3 10:17:16 2024 Delivered-To: importer@patchew.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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1599585722; cv=none; d=zohomail.com; s=zohoarc; b=fHHt27oe/Fe4h4thUvwmbqnqdrLVowE/UWIAY7+Twp+7rR53FWNLvIm1a7dE9yfAwLCClh7NzFmEPz6Jn4O7GjINeWnkEgctSDuF4/nfWbBQStzY6f91EtUfjUfxhp9yYxOhFFhQp/a92le+YoyasjHsJ+96tuxSy9Z25QhelMw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1599585722; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=gK/VCXtHFB7xDjj0ObOYEF6qXiuSeGaLia0yIE0KiiU=; b=XsXDH+NolZtTx/qL0IaUN1MnwdBALrhj604TAyWAmcw0t3qE5fXDLh+H4RfKPPRCgiJoz3FQDm7hwsoH1nCM5+qnguU6Rd4aPgL0bU/km6IRogLP30l+s4th4DCs9nY06MUWoWwLyMpmVy8sTOP4EIRqvxCSEnqqVHeUWkYpiqE= 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 1599585722275335.7768137006435; Tue, 8 Sep 2020 10:22:02 -0700 (PDT) Received: from localhost ([::1]:42822 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kFhJg-0006HR-Tx for importer@patchew.org; Tue, 08 Sep 2020 13:22:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60800) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kFhJ3-0005Zk-6m for qemu-devel@nongnu.org; Tue, 08 Sep 2020 13:21:21 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:45112) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kFhIz-0007cu-U1 for qemu-devel@nongnu.org; Tue, 08 Sep 2020 13:21:20 -0400 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-471-VNPdvCUINk217heYjuBx1A-1; Tue, 08 Sep 2020 13:21:14 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8A9EC18BE163; Tue, 8 Sep 2020 17:21:13 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-112-122.ams2.redhat.com [10.36.112.122]) by smtp.corp.redhat.com (Postfix) with ESMTP id 989A786589; Tue, 8 Sep 2020 17:21:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599585676; 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; bh=gK/VCXtHFB7xDjj0ObOYEF6qXiuSeGaLia0yIE0KiiU=; b=OMYfZ6PkXolGFoGrM6b/bHQXva0pc3XGxiZwOFqAYiUSzw4YvZd3wb21tq5jtt+gI44Sjx NfLw9ZbKhoa2eRiJxrHpERaSDCIa+9I7sWISbGK2rLjfGIoqkpdIPExL5wwRlKYLxC5Gpg AOhrghjxsEWEeAJWZ9aO8h65YzbYnU8= X-MC-Unique: VNPdvCUINk217heYjuBx1A-1 From: Laszlo Ersek To: qemu devel list Subject: [PATCH RESEND] manual: escape backslashes in "parsed-literal" blocks Date: Tue, 8 Sep 2020 19:21:11 +0200 Message-Id: <20200908172111.19072-1-lersek@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=lersek@redhat.com X-Mimecast-Spam-Score: 0.002 X-Mimecast-Originator: redhat.com 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=216.205.24.124; envelope-from=lersek@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/08 02:10:54 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 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, MIME_BASE64_TEXT=1.741, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=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 Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" According to , "inline markup is recognized and there is no protection from parsing. Backslash-escapes may be necessary to prevent unintended parsing". The qemu(1) manual page (formatted with Sphinx 2.2.2) has several overlong lines on my system. A stand-alone backslash at EOL serves as line continuation in a "parsed-literal" block. Therefore, escape the backslashes that we want to appear as such in the formatted documentation. Cc: Peter Maydell Signed-off-by: Laszlo Ersek Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- Notes: Resending with Peter's email address in the Cc: tag fixed. Sorry! docs/system/device-url-syntax.rst.inc | 8 +- qemu-options.hx | 108 ++++++++++---------- 2 files changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url= -syntax.rst.inc index 88d7a372a748..6f6ec8366b7a 100644 --- a/docs/system/device-url-syntax.rst.inc +++ b/docs/system/device-url-syntax.rst.inc @@ -25,8 +25,8 @@ These are specified using a special URL syntax. =20 .. parsed-literal:: =20 - |qemu_system| -iscsi initiator-name=3Diqn.2001-04.com.example:my-ini= tiator \ - -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ + |qemu_system| -iscsi initiator-name=3Diqn.2001-04.com.example:my-ini= tiator \\ + -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 = \\ -drive file=3Discsi://192.0.2.1/iqn.2001-04.com.exa= mple/1 =20 Example (CHAP username/password via URL): @@ -39,8 +39,8 @@ These are specified using a special URL syntax. =20 .. parsed-literal:: =20 - LIBISCSI_CHAP_USERNAME=3D"user" \ - LIBISCSI_CHAP_PASSWORD=3D"password" \ + LIBISCSI_CHAP_USERNAME=3D"user" \\ + LIBISCSI_CHAP_PASSWORD=3D"password" \\ |qemu_system| -drive file=3Discsi://192.0.2.1/iqn.2001-04.com.exampl= e/1 =20 ``NBD`` diff --git a/qemu-options.hx b/qemu-options.hx index b0f020594eab..47f64be0c041 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -373,9 +373,9 @@ SRST =20 .. parsed-literal:: =20 - |qemu_system| \ - -add-fd fd=3D3,set=3D2,opaque=3D"rdwr:/path/to/file" \ - -add-fd fd=3D4,set=3D2,opaque=3D"rdonly:/path/to/file" \ + |qemu_system| \\ + -add-fd fd=3D3,set=3D2,opaque=3D"rdwr:/path/to/file" \\ + -add-fd fd=3D4,set=3D2,opaque=3D"rdonly:/path/to/file" \\ -drive file=3D/dev/fdset/2,index=3D0,media=3Ddisk ERST =20 @@ -1338,9 +1338,9 @@ SRST =20 .. parsed-literal:: =20 - |qemu_system| \ - -add-fd fd=3D3,set=3D2,opaque=3D"rdwr:/path/to/file" \ - -add-fd fd=3D4,set=3D2,opaque=3D"rdonly:/path/to/file" \ + |qemu_system| \\ + -add-fd fd=3D3,set=3D2,opaque=3D"rdwr:/path/to/file" \\ + -add-fd fd=3D4,set=3D2,opaque=3D"rdonly:/path/to/file" \\ -drive file=3D/dev/fdset/2,index=3D0,media=3Ddisk =20 You can connect a CDROM to the slave of ide0: @@ -2593,7 +2593,7 @@ SRST =20 .. parsed-literal:: =20 - |qemu_system| -hda linux.img -boot n -device e1000,netdev=3Dn1= \ + |qemu_system| -hda linux.img -boot n -device e1000,netdev=3Dn1= \\ -netdev user,id=3Dn1,tftp=3D/path/to/tftp/files,bootfile= =3D/pxelinux.0 =20 ``smb=3Ddir[,smbserver=3Daddr]`` @@ -2703,15 +2703,15 @@ SRST =20 #launch a QEMU instance with two NICs, each one connected #to a TAP device - |qemu_system| linux.img \ - -netdev tap,id=3Dnd0,ifname=3Dtap0 -device e1000,netdev=3D= nd0 \ + |qemu_system| linux.img \\ + -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 - |qemu_system| linux.img -device virtio-net-pci,netdev=3Dn1 \ + |qemu_system| linux.img -device virtio-net-pci,netdev=3Dn1 \\ -netdev tap,id=3Dn1,"helper=3D/path/to/qemu-bridge-helper" =20 ``-netdev bridge,id=3Did[,br=3Dbridge][,helper=3Dhelper]`` @@ -2749,12 +2749,12 @@ SRST .. parsed-literal:: =20 # launch a first QEMU instance - |qemu_system| linux.img \ - -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \\ -netdev socket,id=3Dn1,listen=3D:1234 # connect the network of this instance to the network of the first= instance - |qemu_system| linux.img \ - -device e1000,netdev=3Dn2,mac=3D52:54:00:12:34:57= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn2,mac=3D52:54:00:12:34:57= \\ -netdev socket,id=3Dn2,connect=3D127.0.0.1:1234 =20 ``-netdev socket,id=3Did[,fd=3Dh][,mcast=3Dmaddr:port[,localaddr=3Daddr]]`` @@ -2776,16 +2776,16 @@ SRST .. parsed-literal:: =20 # launch one QEMU instance - |qemu_system| linux.img \ - -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \\ -netdev socket,id=3Dn1,mcast=3D230.0.0.1:1234 # launch another QEMU instance on same "bus" - |qemu_system| linux.img \ - -device e1000,netdev=3Dn2,mac=3D52:54:00:12:34:57= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn2,mac=3D52:54:00:12:34:57= \\ -netdev socket,id=3Dn2,mcast=3D230.0.0.1:1234 # launch yet another QEMU instance on same "bus" - |qemu_system| linux.img \ - -device e1000,netdev=3Dn3,mac=3D52:54:00:12:34:58= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn3,mac=3D52:54:00:12:34:58= \\ -netdev socket,id=3Dn3,mcast=3D230.0.0.1:1234 =20 Example (User Mode Linux compat.): @@ -2793,8 +2793,8 @@ SRST .. parsed-literal:: =20 # launch QEMU instance (note mcast address selected is UML's defau= lt) - |qemu_system| linux.img \ - -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \\ -netdev socket,id=3Dn1,mcast=3D239.192.168.1:1102 # launch UML /path/to/linux ubd0=3D/path/to/root_fs eth0=3Dmcast @@ -2803,8 +2803,8 @@ SRST =20 .. parsed-literal:: =20 - |qemu_system| linux.img \ - -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \ + |qemu_system| linux.img \\ + -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \\ -netdev socket,id=3Dn1,mcast=3D239.192.168.1:1102= ,localaddr=3D1.2.3.4 =20 ``-netdev l2tpv3,id=3Did,src=3Dsrcaddr,dst=3Ddstaddr[,srcport=3Dsrcport][,= dstport=3Ddstport],txsession=3Dtxsession[,rxsession=3Drxsession][,ipv6][,ud= p][,cookie64][,counter][,pincounter][,txcookie=3Dtxcookie][,rxcookie=3Drxco= okie][,offset=3Doffset]`` @@ -2860,9 +2860,9 @@ SRST =20 # Setup tunnel on linux host using raw ip as encapsulation # on 1.2.3.4 - ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_t= unnel_id 1 \ + ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_t= unnel_id 1 \\ encap udp udp_sport 16384 udp_dport 16384 - ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ + ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \\ 0xFFFFFFFF peer_session_id 0xFFFFFFFF ifconfig vmtunnel0 mtu 1500 ifconfig vmtunnel0 up @@ -2872,7 +2872,7 @@ SRST # on 4.3.2.1 # launch QEMU instance - if your network has reorder or is very lo= ssy add ,pincounter =20 - |qemu_system| linux.img -device e1000,netdev=3Dn1 \ + |qemu_system| linux.img -device e1000,netdev=3Dn1 \\ -netdev l2tpv3,id=3Dn1,src=3D4.2.3.1,dst=3D1.2.3.4,udp,srcport= =3D16384,dstport=3D16384,rxsession=3D0xffffffff,txsession=3D0xffffffff,coun= ter =20 ``-netdev vde,id=3Did[,sock=3Dsocketpath][,port=3Dn][,group=3Dgroupname][,= mode=3Doctalmode]`` @@ -4627,8 +4627,8 @@ SRST =20 .. parsed-literal:: =20 - # |qemu_system| \ - -object tls-cipher-suites,id=3Dmysuite0,priority=3D@SYSTE= M \ + # |qemu_system| \\ + -object tls-cipher-suites,id=3Dmysuite0,priority=3D@SYSTE= M \\ -fw_cfg name=3Detc/edk2/https/ciphers,gen_id=3Dmysuite0 =20 ``-object filter-buffer,id=3Did,netdev=3Dnetdevid,interval=3Dt[,queue= =3Dall|rx|tx][,status=3Don|off][,position=3Dhead|tail|id=3D][,insert=3D= behind|before]`` @@ -4791,10 +4791,10 @@ SRST =20 .. parsed-literal:: =20 - # |qemu_system| \ - [...] \ - -object cryptodev-backend-builtin,id=3Dcryptodev0 \ - -device virtio-crypto-pci,id=3Dcrypto0,cryptodev=3Dcryp= todev0 \ + # |qemu_system| \\ + [...] \\ + -object cryptodev-backend-builtin,id=3Dcryptodev0 \\ + -device virtio-crypto-pci,id=3Dcrypto0,cryptodev=3Dcryp= todev0 \\ [...] =20 ``-object cryptodev-vhost-user,id=3Did,chardev=3Dchardevid[,queues=3Dq= ueues]`` @@ -4810,11 +4810,11 @@ SRST =20 .. parsed-literal:: =20 - # |qemu_system| \ - [...] \ - -chardev socket,id=3Dchardev0,path=3D/path/to/socket \ - -object cryptodev-vhost-user,id=3Dcryptodev0,chardev=3D= chardev0 \ - -device virtio-crypto-pci,id=3Dcrypto0,cryptodev=3Dcryp= todev0 \ + # |qemu_system| \\ + [...] \\ + -chardev socket,id=3Dchardev0,path=3D/path/to/socket \\ + -object cryptodev-vhost-user,id=3Dcryptodev0,chardev=3D= chardev0 \\ + -device virtio-crypto-pci,id=3Dcrypto0,cryptodev=3Dcryp= todev0 \\ [...] =20 ``-object secret,id=3Did,data=3Dstring,format=3Draw|base64[,keyid=3Dse= cretid,iv=3Dstring]`` @@ -4892,9 +4892,9 @@ SRST =20 .. parsed-literal:: =20 - # |qemu_system| \ - -object secret,id=3Dsecmaster0,format=3Dbase64,file=3Dkey= .b64 \ - -object secret,id=3Dsec0,keyid=3Dsecmaster0,format=3Dbase= 64,\ + # |qemu_system| \\ + -object secret,id=3Dsecmaster0,format=3Dbase64,file=3Dkey= .b64 \\ + -object secret,id=3Dsec0,keyid=3Dsecmaster0,format=3Dbase= 64,\\ data=3D$SECRET,iv=3D$(