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")
Signed-off-by: Parav Pandit <parav@nvidia.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

diff --git a/devlink/devlink.c b/devlink/devlink.c
index 9d3acc1883960fc6f6ad68da770645eb84fcbf26..2f2142ed385666cde1d280fd0c792a35917853a1 100644 (file)
--- a/devlink/devlink.c
+++ b/devlink/devlink.c
@@ -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");

diff --git a/man/man8/devlink-port.8 b/man/man8/devlink-port.8
index 053db7a1eb2510acdcde488abe71a4b583daadd3..12ccc47ed7ca2a4fea3db424af2d563ac6980b3d 100644 (file)
--- a/man/man8/devlink-port.8
+++ b/man/man8/devlink-port.8
@@ -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 "