doc/net/l2tpv3: Update boolean fields' description to avoid short-form use

The short-form boolean options has been deprecated since v6.0 (refer
to docs/about/deprecated.rst).

Update the description and example of boolean fields in l2tpv3 option to
avoid deprecation warning.

Cc: Jason Wang <jasowang@redhat.com>
Signed-off-by: Zhao Liu <zhao1.liu@intel.com>
Reviewed-by: Michael Tokarev <mjt@tls.msk.ru>
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
This commit is contained in:
Zhao Liu 2024-07-08 17:26:30 +08:00 committed by Michael Tokarev
parent 29ea19465b
commit cb8de74ac6
1 changed files with 5 additions and 5 deletions

View File

@ -3353,7 +3353,7 @@ SRST
-device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\
-netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4
``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on|off][,udp=on|off][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]`` ``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on|off][,udp=on|off][,cookie64=on|off][,counter=on|off][,pincounter=on|off][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]``
Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931)
is a popular protocol to transport Ethernet (and other Layer 2) data is a popular protocol to transport Ethernet (and other Layer 2) data
frames between two systems. It is present in routers, firewalls and frames between two systems. It is present in routers, firewalls and
@ -3368,7 +3368,7 @@ SRST
``dst=dstaddr`` ``dst=dstaddr``
destination address (mandatory) destination address (mandatory)
``udp`` ``udp=on``
select udp encapsulation (default is ip). select udp encapsulation (default is ip).
``srcport=srcport`` ``srcport=srcport``
@ -3377,7 +3377,7 @@ SRST
``dstport=dstport`` ``dstport=dstport``
destination udp port. destination udp port.
``ipv6`` ``ipv6=on``
force v6, otherwise defaults to v4. force v6, otherwise defaults to v4.
``rxcookie=rxcookie``; \ ``txcookie=txcookie`` ``rxcookie=rxcookie``; \ ``txcookie=txcookie``
@ -3385,7 +3385,7 @@ SRST
Their function is mostly to prevent misconfiguration. By default Their function is mostly to prevent misconfiguration. By default
they are 32 bit. they are 32 bit.
``cookie64`` ``cookie64=on``
Set cookie size to 64 bit instead of the default 32 Set cookie size to 64 bit instead of the default 32
``counter=off`` ``counter=off``
@ -3419,7 +3419,7 @@ SRST
# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
|qemu_system| linux.img -device e1000,netdev=n1 \\ |qemu_system| linux.img -device e1000,netdev=n1 \\
-netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp=on,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter=on
``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]`` ``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]``
Configure VDE backend to connect to PORT n of a vde switch running Configure VDE backend to connect to PORT n of a vde switch running