[PATCH iproute2 v2 0/2] iplink: update doc related to the 'netns' arg

[PATCH iproute2 v2 0/2] iplink: update doc related to the 'netns' arg

[Nicolas Dichtel]

v1 -> v2:
 - add patch 1/2
 - s/NETNS_FILE/NETNSFILE
 - describe NETNSNAME in the DESCRIPTION section of man pages

 ip/iplink.c           |  4 ++--
 man/man8/ip-link.8.in | 10 ++++++----
 2 files changed, 8 insertions(+), 6 deletions(-)

Regards,
Nicolas

[PATCH iproute2 v2 1/2] iplink: use the same token NETNSNAME everywhere

[Nicolas Dichtel]

Use NETNSNAME everywhere to ensure consistency between man pages and help
of the 'ip' command.

Signed-off-by: Nicolas Dichtel <nicolas.dichtel@6wind.com>
---
 ip/iplink.c           | 4 ++--
 man/man8/ip-link.8.in | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/ip/iplink.c b/ip/iplink.c
index a8da52f9f7ca..8755fa076dab 100644
--- a/ip/iplink.c
+++ b/ip/iplink.c
@@ -63,7 +63,7 @@ void iplink_usage(void)
 			"		    [ mtu MTU ] [index IDX ]\n"
 			"		    [ numtxqueues QUEUE_COUNT ]\n"
 			"		    [ numrxqueues QUEUE_COUNT ]\n"
-			"		    [ netns { PID | NAME } ]\n"
+			"		    [ netns { PID | NETNSNAME } ]\n"
 			"		    type TYPE [ ARGS ]\n"
 			"\n"
 			"	ip link delete { DEVICE | dev DEVICE | group DEVGROUP } type TYPE [ ARGS ]\n"
@@ -88,7 +88,7 @@ void iplink_usage(void)
 		"		[ address LLADDR ]\n"
 		"		[ broadcast LLADDR ]\n"
 		"		[ mtu MTU ]\n"
-		"		[ netns { PID | NAME } ]\n"
+		"		[ netns { PID | NETNSNAME } ]\n"
 		"		[ link-netns NAME | link-netnsid ID ]\n"
 		"		[ alias NAME ]\n"
 		"		[ vf NUM [ mac LLADDR ]\n"
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index c8c656579364..a4e0c4030363 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -465,7 +465,7 @@ specifies the desired index of the new virtual device. The link
 creation fails, if the index is busy.
 
 .TP
-.BI netns " { PID | NAME } "
+.BI netns " { PID | NETNSNAME } "
 specifies the desired network namespace to create interface in.
 
 .TP
-- 
2.39.2

[PATCH iproute2 v2 2/2] iplink: fix help of 'netns' arg

[Nicolas Dichtel]

'ip link set foo netns /proc/1/ns/net' is a valid command.
Let's update the doc accordingly.

Fixes: 0dc34c7713bb ("iproute2: Add processless network namespace support")
Signed-off-by: Nicolas Dichtel <nicolas.dichtel@6wind.com>
---
 ip/iplink.c           |  4 ++--
 man/man8/ip-link.8.in | 10 ++++++----
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/ip/iplink.c b/ip/iplink.c
index 8755fa076dab..9ac3b8cb2ad5 100644
--- a/ip/iplink.c
+++ b/ip/iplink.c
@@ -63,7 +63,7 @@ void iplink_usage(void)
 			"		    [ mtu MTU ] [index IDX ]\n"
 			"		    [ numtxqueues QUEUE_COUNT ]\n"
 			"		    [ numrxqueues QUEUE_COUNT ]\n"
-			"		    [ netns { PID | NETNSNAME } ]\n"
+			"		    [ netns { PID | NETNSNAME | NETNSFILE } ]\n"
 			"		    type TYPE [ ARGS ]\n"
 			"\n"
 			"	ip link delete { DEVICE | dev DEVICE | group DEVGROUP } type TYPE [ ARGS ]\n"
@@ -88,7 +88,7 @@ void iplink_usage(void)
 		"		[ address LLADDR ]\n"
 		"		[ broadcast LLADDR ]\n"
 		"		[ mtu MTU ]\n"
-		"		[ netns { PID | NETNSNAME } ]\n"
+		"		[ netns { PID | NETNSNAME | NETNSFILE } ]\n"
 		"		[ link-netns NAME | link-netnsid ID ]\n"
 		"		[ alias NAME ]\n"
 		"		[ vf NUM [ mac LLADDR ]\n"
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index a4e0c4030363..59deaa2c1263 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -49,7 +49,7 @@ ip-link \- network device configuration
 .IR BYTES " ]"
 .br
 .RB "[ " netns " {"
-.IR PID " | " NETNSNAME " } ]"
+.IR PID " | " NETNSNAME " | " NETNSFILE " } ]"
 .br
 .BI type " TYPE"
 .RI "[ " ARGS " ]"
@@ -118,7 +118,7 @@ ip-link \- network device configuration
 .IR MTU " ]"
 .br
 .RB "[ " netns " {"
-.IR PID " | " NETNSNAME " } ]"
+.IR PID " | " NETNSNAME " | " NETNSFILE " } ]"
 .br
 .RB "[ " link-netnsid
 .IR ID " ]"
@@ -465,7 +465,7 @@ specifies the desired index of the new virtual device. The link
 creation fails, if the index is busy.
 
 .TP
-.BI netns " { PID | NETNSNAME } "
+.BI netns " { PID | NETNSNAME | NETNSFILE } "
 specifies the desired network namespace to create interface in.
 
 .TP
@@ -2188,9 +2188,11 @@ the interface is
 .IR "POINTOPOINT" .
 
 .TP
-.BI netns " NETNSNAME " \fR| " PID"
+.BI netns " NETNSNAME " \fR| " NETNSFILE " \fR| " PID"
 move the device to the network namespace associated with name
 .IR "NETNSNAME " or
+the file
+.IR "NETNSFILE " or
 .RI process " PID".
 
 Some devices are not allowed to change network namespace: loopback, bridge,
-- 
2.39.2

Re: [PATCH iproute2 v2 2/2] iplink: fix help of 'netns' arg

[Simon Horman]

On Thu, Apr 20, 2023 at 10:48:49AM +0200, Nicolas Dichtel wrote:
> [You don't often get email from nicolas.dichtel@6wind.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> 'ip link set foo netns /proc/1/ns/net' is a valid command.
> Let's update the doc accordingly.
> 
> Fixes: 0dc34c7713bb ("iproute2: Add processless network namespace support")
> Signed-off-by: Nicolas Dichtel <nicolas.dichtel@6wind.com>
> ---
>  ip/iplink.c           |  4 ++--
>  man/man8/ip-link.8.in | 10 ++++++----
>  2 files changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/ip/iplink.c b/ip/iplink.c
> index 8755fa076dab..9ac3b8cb2ad5 100644
> --- a/ip/iplink.c
> +++ b/ip/iplink.c
> @@ -63,7 +63,7 @@ void iplink_usage(void)
>                         "                   [ mtu MTU ] [index IDX ]\n"
>                         "                   [ numtxqueues QUEUE_COUNT ]\n"
>                         "                   [ numrxqueues QUEUE_COUNT ]\n"
> -                       "                   [ netns { PID | NETNSNAME } ]\n"
> +                       "                   [ netns { PID | NETNSNAME | NETNSFILE } ]\n"
>                         "                   type TYPE [ ARGS ]\n"
>                         "\n"
>                         "       ip link delete { DEVICE | dev DEVICE | group DEVGROUP } type TYPE [ ARGS ]\n"
> @@ -88,7 +88,7 @@ void iplink_usage(void)
>                 "               [ address LLADDR ]\n"
>                 "               [ broadcast LLADDR ]\n"
>                 "               [ mtu MTU ]\n"
> -               "               [ netns { PID | NETNSNAME } ]\n"
> +               "               [ netns { PID | NETNSNAME | NETNSFILE } ]\n"
>                 "               [ link-netns NAME | link-netnsid ID ]\n"
>                 "               [ alias NAME ]\n"
>                 "               [ vf NUM [ mac LLADDR ]\n"
> diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
> index a4e0c4030363..59deaa2c1263 100644
> --- a/man/man8/ip-link.8.in
> +++ b/man/man8/ip-link.8.in
> @@ -49,7 +49,7 @@ ip-link \- network device configuration
>  .IR BYTES " ]"
>  .br
>  .RB "[ " netns " {"
> -.IR PID " | " NETNSNAME " } ]"
> +.IR PID " | " NETNSNAME " | " NETNSFILE " } ]"
>  .br
>  .BI type " TYPE"
>  .RI "[ " ARGS " ]"
> @@ -118,7 +118,7 @@ ip-link \- network device configuration
>  .IR MTU " ]"
>  .br
>  .RB "[ " netns " {"
> -.IR PID " | " NETNSNAME " } ]"
> +.IR PID " | " NETNSNAME " | " NETNSFILE " } ]"
>  .br
>  .RB "[ " link-netnsid
>  .IR ID " ]"
> @@ -465,7 +465,7 @@ specifies the desired index of the new virtual device. The link
>  creation fails, if the index is busy.
> 
>  .TP
> -.BI netns " { PID | NETNSNAME } "
> +.BI netns " { PID | NETNSNAME | NETNSFILE } "
>  specifies the desired network namespace to create interface in.
> 
>  .TP
> @@ -2188,9 +2188,11 @@ the interface is
>  .IR "POINTOPOINT" .
> 
>  .TP
> -.BI netns " NETNSNAME " \fR| " PID"
> +.BI netns " NETNSNAME " \fR| " NETNSFILE " \fR| " PID"

nit: The text in this and the previous hunk was and is inconsistent.
     Is that something that could be addressed (at some point) ?

>  move the device to the network namespace associated with name
>  .IR "NETNSNAME " or
> +the file
> +.IR "NETNSFILE " or
>  .RI process " PID".
> 
>  Some devices are not allowed to change network namespace: loopback, bridge,
> --
> 2.39.2
> 

Re: [PATCH iproute2 v2 2/2] iplink: fix help of 'netns' arg

[Nicolas Dichtel]

Le 20/04/2023 à 13:27, Simon Horman a écrit :
[snip]
> nit: The text in this and the previous hunk was and is inconsistent.
>      Is that something that could be addressed (at some point) ?

I will send a v3. Just waiting a bit in case there are more comments.


Regards,
Nicolas