From: Devin J. Pohly <djpohly@gmail.com>
Date: Mon, 18 May 2020 20:58:28 +0000 (-0500)
Subject: veth.4: Add a more direct example
X-Git-Tag: man-pages-5.07~95
X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fman-pages.git;a=commitdiff_plain;h=1b0b13fe97e372d5f234ab87de5afaa1df7b80fd

veth.4: Add a more direct example

iproute2 allows you to specify the netns for either side of a veth
interface at creation time.  Add an example of this to veth(4) so
it doesn't sound like you have to move the interfaces in a
separate step.

Verified with commands:
    # ip netns add alpha
    # ip netns add bravo
    # ip link add foo netns alpha type veth peer bar netns bravo
    # ip -n alpha link show
    # ip -n bravo link show

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
---

diff --git a/man4/veth.4 b/man4/veth.4
index 20294c097d..2d59882a07 100644
--- a/man4/veth.4
+++ b/man4/veth.4
@@ -63,13 +63,23 @@ A particularly interesting use case is to place one end of a
 .B veth
 pair in one network namespace and the other end in another network namespace,
 thus allowing communication between network namespaces.
-To do this, one first creates the
+To do this, one can provide the
+.B netns
+parameter when creating the interfaces:
+.PP
+.in +4n
+.EX
+# ip link add <p1-name> netns <p1-ns> type veth peer <p2-name> netns <p2-ns>
+.EE
+.in
+.PP
+or, for an existing
 .B veth
-device as above and then moves one side of the pair to the other namespace:
+pair, move one side to the other namespace:
 .PP
 .in +4n
 .EX
-# ip link set <p2-name> netns <p2-namespace>
+# ip link set <p2-name> netns <p2-ns>
 .EE
 .in
 .PP