ip: add vxcan/veth to ip-link man page

PATCH Applied Oliver Hartkopp 2 participants 2 messages Dec 16, 2017

Subsystems (3)

Networking Network drivers CAN network drivers

lore

Share & tools

lore

Oliver Hartkopp

author

2017-12-16 11:38 UTC #0 lore raw

PATCH 1/1 ip: add vxcan/veth to ip-link man page

veth and vxcan both create a vitual tunnel between a pair of virtual network devices. This patch adds the content for the now supported vxcan netdevices and the documentation to create peer devices for vxcan and veth.

Additional remove 'can' that accidently was on the list of link types which can be created by 'ip link add' as 'can' devices are real network devices.

Signed-off-by Oliver Hartkopp <[email protected]>

---
 man/man8/ip-link.8.in | 30 +++++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

man/man8/ip-link.8.in +27 -3

index a6a10e57..94ecbece 100644
@@ -194,6 +194,7 @@ ip-link \- network device configuration
 .BR macvlan  " | "
 .BR macvtap  " | "
 .BR vcan " | "
+.BR vxcan " | "
 .BR veth " | "
 .BR vlan " | "
 .BR vxlan " |"

@@ -252,9 +253,6 @@ Link types:
 .B bond
 - Bonding device
 .sp
-.B can
-- Controller Area Network interface
-.sp
 .B dummy
 - Dummy network interface
 .sp

@@ -276,6 +274,9 @@ Link types:
 .B vcan
 - Virtual Controller Area Network interface
 .sp
+.B vxcan
+- Virtual Controller Area Network tunnel interface
+.sp
 .B veth
 - Virtual ethernet interface
 .sp

@@ -651,6 +652,29 @@ keyword.
 
 .in -8
 
+.TP
+VETH, VXCAN Type Support
+For a link of types
+.I VETH/VXCAN
+the following additional arguments are supported:
+
+.BI "ip link add " DEVICE
+.BR type " { " veth " | " vxcan " }"
+[
+.BR peer
+.BI "name " NAME
+]
+
+.in +8
+.sp
+.BR peer
+.BI "name " NAME
+- specifies the virtual pair device name of the
+.I VETH/VXCAN
+tunnel.
+
+.in -8
+
 .TP
 GRE, IPIP, SIT, ERSPAN Type Support
 For a link of types

Signature · 1 line

2.15.1

Stephen Hemminger

Applied

2017-12-16 18:08 UTC #1 lore raw

Quoted 8 lines · On Sat, 16 Dec 2017 12:38:57 +0100 Oliver Hartkopp <[email protected]>…

veth and vxcan both create a vitual tunnel between a pair of virtual network devices. This patch adds the content for the now supported vxcan netdevices and the documentation to create peer devices for vxcan and veth.
Additional remove 'can' that accidently was on the list of link types which can be created by 'ip link add' as 'can' devices are real network devices.
Signed-off-by Oliver Hartkopp <[email protected]>

Applied. Thanks for the doing this.