diff mbox series

[net] Documentation: bareudp: update iproute2 sample commands

Message ID 57d0fff72970fdc7d49ab969f940438728f10754.1595259799.git.gnault@redhat.com
State Accepted
Delegated to: David Miller
Headers show
Series [net] Documentation: bareudp: update iproute2 sample commands | expand

Commit Message

Guillaume Nault July 20, 2020, 3:46 p.m. UTC
bareudp.rst was written before iproute2 gained support for this new
type of tunnel. Therefore, the sample command lines didn't match the
final iproute2 implementation.

Signed-off-by: Guillaume Nault <gnault@redhat.com>
---
 Documentation/networking/bareudp.rst | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

Comments

David Miller July 21, 2020, 12:57 a.m. UTC | #1
From: Guillaume Nault <gnault@redhat.com>
Date: Mon, 20 Jul 2020 17:46:58 +0200

> bareudp.rst was written before iproute2 gained support for this new
> type of tunnel. Therefore, the sample command lines didn't match the
> final iproute2 implementation.
> 
> Signed-off-by: Guillaume Nault <gnault@redhat.com>

Applied, thank you.
diff mbox series

Patch

diff --git a/Documentation/networking/bareudp.rst b/Documentation/networking/bareudp.rst
index 465a8b251bfe..ff406563ea88 100644
--- a/Documentation/networking/bareudp.rst
+++ b/Documentation/networking/bareudp.rst
@@ -26,7 +26,7 @@  Usage
 
 1) Device creation & deletion
 
-    a) ip link add dev bareudp0 type bareudp dstport 6635 ethertype 0x8847.
+    a) ip link add dev bareudp0 type bareudp dstport 6635 ethertype mpls_uc
 
        This creates a bareudp tunnel device which tunnels L3 traffic with ethertype
        0x8847 (MPLS traffic). The destination port of the UDP header will be set to
@@ -34,14 +34,21 @@  Usage
 
     b) ip link delete bareudp0
 
-2) Device creation with multiple proto mode enabled
+2) Device creation with multiproto mode enabled
 
-There are two ways to create a bareudp device for MPLS & IP with multiproto mode
-enabled.
+The multiproto mode allows bareudp tunnels to handle several protocols of the
+same family. It is currently only available for IP and MPLS. This mode has to
+be enabled explicitly with the "multiproto" flag.
 
-    a) ip link add dev  bareudp0 type bareudp dstport 6635 ethertype 0x8847 multiproto
+    a) ip link add dev bareudp0 type bareudp dstport 6635 ethertype ipv4 multiproto
 
-    b) ip link add dev  bareudp0 type bareudp dstport 6635 ethertype mpls
+       For an IPv4 tunnel the multiproto mode allows the tunnel to also handle
+       IPv6.
+
+    b) ip link add dev bareudp0 type bareudp dstport 6635 ethertype mpls_uc multiproto
+
+       For MPLS, the multiproto mode allows the tunnel to handle both unicast
+       and multicast MPLS packets.
 
 3) Device Usage