Skip to contentSkip to conversation

devlink: Show port state values in man page and in the help command

PATCH In review Parav Pandit 2 participants 4 messages Jul 23, 2021 – Aug 10, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 devlink: Show port state values in man page and in the help command

Port function state can have either of the two values - active or inactive. Update the documentation and help command for these two values to tell user about it.

With the introduction of state, hw_addr and state are optional. Hence mark them as optional in man page that also aligns with the help command output.

Fixes bdfb9f1bd61a ("devlink: Support set of port function state")
---
 devlink/devlink.c       |  2 +-
 man/man8/devlink-port.8 | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
devlink/devlink.c +1 -1
index b294fcd8..cf723e1b 100644
@@ -3988,7 +3988,7 @@ static void cmd_port_help(void)
 	pr_err("       devlink port set DEV/PORT_INDEX [ type { eth | ib | auto} ]\n");
 	pr_err("       devlink port split DEV/PORT_INDEX count COUNT\n");
 	pr_err("       devlink port unsplit DEV/PORT_INDEX\n");
-	pr_err("       devlink port function set DEV/PORT_INDEX [ hw_addr ADDR ] [ state STATE ]\n");
+	pr_err("       devlink port function set DEV/PORT_INDEX [ hw_addr ADDR ] [ state { active | inactive } ]\n");
 	pr_err("       devlink port function rate { help | show | add | del | set }\n");
 	pr_err("       devlink port param set DEV/PORT_INDEX name PARAMETER value VALUE cmode { permanent | driverinit | runtime }\n");
 	pr_err("       devlink port param show [DEV/PORT_INDEX name PARAMETER]\n");
man/man8/devlink-port.8 +5 -5
index 053db7a1..12ccc47e 100644
@@ -67,12 +67,12 @@ devlink-port \- devlink port configuration
 .ti -8
 .BR "devlink port function set "
 .IR DEV/PORT_INDEX
-.RI "{ "
+.RI "[ "
 .BR "hw_addr "
-.RI "ADDR }"
-.RI "{ "
-.BR "state"
-.RI "STATE }"
+.RI "ADDR ]"
+.RI "[ "
+.BR state " { " active " | " inactive " }"
+.RI "]"
 
 .ti -8
 .BR "devlink port function rate "
Signature · 1 line
2.26.2
#1 lore raw

Hi David, Stephen,

Quoted 11 lines

From: Parav Pandit <[email protected]>
Sent: Friday, July 23, 2021 8:24 PM

Port function state can have either of the two values - active or inactive. Update the documentation and help command for these two values to tell user about it.

With the introduction of state, hw_addr and state are optional. Hence mark them as optional in man page that also aligns with the help command output.

Quoted 8 lines
Fixes bdfb9f1bd61a ("devlink: Support set of port function state")
---
 devlink/devlink.c       |  2 +-
 man/man8/devlink-port.8 | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

Can you please review this short fix?

Quoted 42 lines
devlink/devlink.c index b294fcd8..cf723e1b renamed from devlink/devlink.c +0 -0

100644

devlink/devlink.c +1 -1
@@ -3988,7 +3988,7 @@ static void cmd_port_help(void)
 	pr_err("       devlink port set DEV/PORT_INDEX [ type { eth | ib | auto}
 ]\n");
 	pr_err("       devlink port split DEV/PORT_INDEX count COUNT\n");
 	pr_err("       devlink port unsplit DEV/PORT_INDEX\n");
-	pr_err("       devlink port function set DEV/PORT_INDEX [ hw_addr
 ADDR ] [ state STATE ]\n");
+	pr_err("       devlink port function set DEV/PORT_INDEX [ hw_addr
 ADDR ] [ state { active | inactive } ]\n");

pr_err(" devlink port function rate { help | show | add | del | set
}\n");
pr_err(" devlink port param set DEV/PORT_INDEX name
PARAMETER value VALUE cmode { permanent | driverinit | runtime }\n");
pr_err(" devlink port param show [DEV/PORT_INDEX name
PARAMETER]\n");

man/man8/devlink-port.8 index renamed from man/man8/devlink-port.8 +0 -0

053db7a1..12ccc47e 100644

man/man8/devlink-port.8 +0 -0
@@ -67,12 +67,12 @@ devlink-port \- devlink port configuration  .ti -8  .BR

"devlink port function set "
.IR DEV/PORT_INDEX
-.RI "{ "
+.RI "[ "
.BR "hw_addr "
-.RI "ADDR }"
-.RI "{ "
-.BR "state"
-.RI "STATE }"
+.RI "ADDR ]"
+.RI "[ "
+.BR state " { " active " | " inactive " }"
+.RI "]"

.ti -8
.BR "devlink port function rate "
--
2.26.2

#2 lore raw
Quoted 21 lines · Parav Pandit

Hi David, Stephen,

Quoted 11 lines

From: Parav Pandit <[email protected]>
Sent: Friday, July 23, 2021 8:24 PM

Port function state can have either of the two values - active or inactive. Update the documentation and help command for these two values to tell user about it.

With the introduction of state, hw_addr and state are optional. Hence mark them as optional in man page that also aligns with the help command output.

Quoted 8 lines
Fixes bdfb9f1bd61a ("devlink: Support set of port function state")
---
 devlink/devlink.c       |  2 +-
 man/man8/devlink-port.8 | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
Quoted 2 lines

Can you please review this short fix?

It is assigned to Stephen, but some how marked as 'archived'. I removed that label and it is back in Stephen's list.

#3 lore raw
Quoted 27 lines

From: David Ahern <[email protected]>
Sent: Tuesday, August 10, 2021 6:48 PM

Quoted 21 lines · Parav Pandit

Hi David, Stephen,

Quoted 19 lines

From: Parav Pandit <[email protected]>
Sent: Friday, July 23, 2021 8:24 PM

Port function state can have either of the two values - active or inactive. Update the documentation and help command for these two values to tell user about it.

With the introduction of state, hw_addr and state are optional. Hence mark them as optional in man page that also aligns with the help command output.

Fixes bdfb9f1bd61a ("devlink: Support set of port function state")
---
 devlink/devlink.c       |  2 +-
 man/man8/devlink-port.8 | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
Quoted 5 lines
Quoted 2 lines

Can you please review this short fix?

It is assigned to Stephen, but some how marked as 'archived'. I removed that label and it is back in Stephen's list.

Ok. Thanks David.