[PATCH] veth.4: Add a more direct example

[PATCH] veth.4: Add a more direct example

[Devin J. Pohly]

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
---
 man4/veth.4 | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/man4/veth.4 b/man4/veth.4
index 20294c097..2d59882a0 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
-- 
2.26.2

Re: [PATCH] veth.4: Add a more direct example

[Michael Kerrisk (man-pages)]

Hello Devin

On 5/18/20 10:58 PM, Devin J. Pohly wrote:
> 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

Nice patch, and nice commit message! Thanks. Applied.

Cheers,

Michael

> ---
>  man4/veth.4 | 16 +++++++++++++---
>  1 file changed, 13 insertions(+), 3 deletions(-)
> 
> diff --git a/man4/veth.4 b/man4/veth.4
> index 20294c097..2d59882a0 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
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/