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

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

[Nicolas Dichtel]

v2 -> v3:
 - make doc about netns arg consistent between 'add' and 'set'

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 | 26 +++++++++++++++++++-------
 2 files changed, 21 insertions(+), 9 deletions(-)

Regards,
Nicolas

[PATCH iproute2 v3 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 v3 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 | 26 +++++++++++++++++++-------
 2 files changed, 21 insertions(+), 9 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..e23474b3589c 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,8 +465,15 @@ specifies the desired index of the new virtual device. The link
 creation fails, if the index is busy.
 
 .TP
-.BI netns " { PID | NETNSNAME } "
-specifies the desired network namespace to create interface in.
+.B netns
+.RI "{ " PID " | " NETNSNAME " | " NETNSFILE " }"
+.br
+create the device in the network namespace associated with process
+.IR "PID " or
+the name
+.IR "NETNSNAME " or
+the file
+.IR "NETNSFILE".
 
 .TP
 VLAN Type Support
@@ -2188,10 +2195,15 @@ the interface is
 .IR "POINTOPOINT" .
 
 .TP
-.BI netns " NETNSNAME " \fR| " PID"
-move the device to the network namespace associated with name
+.B netns
+.RI "{ " PID " | " NETNSNAME " | " NETNSFILE " }"
+.br
+move the device to the network namespace associated with process
+.IR "PID " or
+the name
 .IR "NETNSNAME " or
-.RI process " PID".
+the file
+.IR "NETNSFILE".
 
 Some devices are not allowed to change network namespace: loopback, bridge,
 wireless. These are network namespace local devices. In such case
-- 
2.39.2

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

[Simon Horman]

On Fri, Apr 21, 2023 at 09:47:19AM +0200, Nicolas Dichtel wrote:
> Use NETNSNAME everywhere to ensure consistency between man pages and help
> of the 'ip' command.
> 
> Signed-off-by: Nicolas Dichtel <nicolas.dichtel@6wind.com>

Reviewed-by: Simon Horman <simon.horman@corigine.com>

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

[Simon Horman]

On Fri, Apr 21, 2023 at 09:47:20AM +0200, Nicolas Dichtel wrote:
> '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>

Reviewed-by: Simon Horman <simon.horman@corigine.com>

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

[David Marchand]

Salut Nicolas,

On Fri, Apr 21, 2023 at 9:48 AM Nicolas Dichtel
<nicolas.dichtel@6wind.com> wrote:
>
> '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>

Thanks for the doc update.
Reviewed-by: David Marchand <david.marchand@redhat.com>


-- 
David Marchand

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

[Andrea Claudi]

On Fri, Apr 21, 2023 at 09:47:18AM +0200, Nicolas Dichtel wrote:
> v2 -> v3:
>  - make doc about netns arg consistent between 'add' and 'set'
> 
> 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 | 26 +++++++++++++++++++-------
>  2 files changed, 21 insertions(+), 9 deletions(-)
> 
> Regards,
> Nicolas
> 

Reviewed-by: Andrea Claudi <aclaudi@redhat.com>

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

[patchwork-bot+netdevbpf]

Hello:

This series was applied to iproute2/iproute2.git (main)
by Stephen Hemminger <stephen@networkplumber.org>:

On Fri, 21 Apr 2023 09:47:18 +0200 you wrote:
> v2 -> v3:
>  - make doc about netns arg consistent between 'add' and 'set'
> 
> v1 -> v2:
>  - add patch 1/2
>  - s/NETNS_FILE/NETNSFILE
>  - describe NETNSNAME in the DESCRIPTION section of man pages
> 
> [...]

Here is the summary with links:
  - [iproute2,v3,1/2] iplink: use the same token NETNSNAME everywhere
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=3921f56ec3be
  - [iproute2,v3,2/2] iplink: fix help of 'netns' arg
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=1371d7deaa20

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html