* [PATCH iproute2-next] devlink: Show port state values in man page and in the help command
@ 2021-07-23 14:53 Parav Pandit
2021-08-10 11:49 ` Parav Pandit
0 siblings, 1 reply; 4+ messages in thread
From: Parav Pandit @ 2021-07-23 14:53 UTC (permalink / raw)
To: netdev, dsahern, stephen; +Cc: Parav Pandit, Jiri Pirko
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>
---
devlink/devlink.c | 2 +-
man/man8/devlink-port.8 | 10 +++++-----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/devlink/devlink.c b/devlink/devlink.c
index b294fcd8..cf723e1b 100644
--- 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 053db7a1..12ccc47e 100644
--- 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 "
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
* RE: [PATCH iproute2-next] devlink: Show port state values in man page and in the help command
2021-07-23 14:53 [PATCH iproute2-next] devlink: Show port state values in man page and in the help command Parav Pandit
@ 2021-08-10 11:49 ` Parav Pandit
2021-08-10 13:18 ` David Ahern
0 siblings, 1 reply; 4+ messages in thread
From: Parav Pandit @ 2021-08-10 11:49 UTC (permalink / raw)
To: netdev, dsahern, stephen; +Cc: Jiri Pirko
Hi David, Stephen,
> From: Parav Pandit <parav@nvidia.com>
> 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")
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> Reviewed-by: Jiri Pirko <jiri@nvidia.com>
> ---
> devlink/devlink.c | 2 +-
> man/man8/devlink-port.8 | 10 +++++-----
> 2 files changed, 6 insertions(+), 6 deletions(-)
>
Can you please review this short fix?
> diff --git a/devlink/devlink.c b/devlink/devlink.c index b294fcd8..cf723e1b
> 100644
> --- 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
> 053db7a1..12ccc47e 100644
> --- 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 "
> --
> 2.26.2
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH iproute2-next] devlink: Show port state values in man page and in the help command
2021-08-10 11:49 ` Parav Pandit
@ 2021-08-10 13:18 ` David Ahern
2021-08-10 13:19 ` Parav Pandit
0 siblings, 1 reply; 4+ messages in thread
From: David Ahern @ 2021-08-10 13:18 UTC (permalink / raw)
To: Parav Pandit, netdev, dsahern, stephen; +Cc: Jiri Pirko
On 8/10/21 5:49 AM, Parav Pandit wrote:
> Hi David, Stephen,
>
>> From: Parav Pandit <parav@nvidia.com>
>> 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")
>> Signed-off-by: Parav Pandit <parav@nvidia.com>
>> Reviewed-by: Jiri Pirko <jiri@nvidia.com>
>> ---
>> devlink/devlink.c | 2 +-
>> man/man8/devlink-port.8 | 10 +++++-----
>> 2 files changed, 6 insertions(+), 6 deletions(-)
>>
> 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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* RE: [PATCH iproute2-next] devlink: Show port state values in man page and in the help command
2021-08-10 13:18 ` David Ahern
@ 2021-08-10 13:19 ` Parav Pandit
0 siblings, 0 replies; 4+ messages in thread
From: Parav Pandit @ 2021-08-10 13:19 UTC (permalink / raw)
To: David Ahern, netdev, dsahern, stephen; +Cc: Jiri Pirko
> From: David Ahern <dsahern@gmail.com>
> Sent: Tuesday, August 10, 2021 6:48 PM
>
> On 8/10/21 5:49 AM, Parav Pandit wrote:
> > Hi David, Stephen,
> >
> >> From: Parav Pandit <parav@nvidia.com>
> >> 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")
> >> Signed-off-by: Parav Pandit <parav@nvidia.com>
> >> Reviewed-by: Jiri Pirko <jiri@nvidia.com>
> >> ---
> >> devlink/devlink.c | 2 +-
> >> man/man8/devlink-port.8 | 10 +++++-----
> >> 2 files changed, 6 insertions(+), 6 deletions(-)
> >>
> > 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.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-08-10 13:19 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-23 14:53 [PATCH iproute2-next] devlink: Show port state values in man page and in the help command Parav Pandit
2021-08-10 11:49 ` Parav Pandit
2021-08-10 13:18 ` David Ahern
2021-08-10 13:19 ` Parav Pandit
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.