diff mbox series

[iproute2-next,RESEND] devlink: Extend man page for port function set command

Message ID 20210122050200.207247-1-parav@nvidia.com (mailing list archive)
State Rejected
Delegated to: Stephen Hemminger
Headers show
Series [iproute2-next,RESEND] devlink: Extend man page for port function set command | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Parav Pandit Jan. 22, 2021, 5:02 a.m. UTC
Extended devlink-port man page for synopsis, description and
example for setting devlink port function attribute.

Signed-off-by: Parav Pandit <parav@nvidia.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
---
 man/man8/devlink-port.8 | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Comments

Parav Pandit Jan. 26, 2021, 1:23 p.m. UTC | #1
Hi Stephen,

> From: Parav Pandit <parav@nvidia.com>
> Sent: Friday, January 22, 2021 10:32 AM
> 
> Extended devlink-port man page for synopsis, description and example for
> setting devlink port function attribute.
> 
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> Reviewed-by: Jiri Pirko <jiri@nvidia.com>

Can you please review this short update?

> ---
>  man/man8/devlink-port.8 | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
> 
> diff --git a/man/man8/devlink-port.8 b/man/man8/devlink-port.8 index
> 966faae6..7e2dc110 100644
> --- a/man/man8/devlink-port.8
> +++ b/man/man8/devlink-port.8
> @@ -46,6 +46,12 @@ devlink-port \- devlink port configuration  .ti -8  .B
> devlink port help
> 
> +.ti -8
> +.BR "devlink port function set "
> +.RI "[ "
> +.BR "hw_addr "
> +.RI "ADDR ]"
> +
>  .SH "DESCRIPTION"
>  .SS devlink port set - change devlink port attributes
> 
> @@ -99,6 +105,16 @@ If this argument is omitted all ports are listed.
>  Is an alias for
>  .BR devlink-health (8).
> 
> +.SS devlink port function set - Set the port function attribute.
> +
> +.PP
> +.B "DEV/PORT_INDEX"
> +- specifies the devlink port to operate on.
> +
> +.PP
> +.BI hw_addr " ADDR"
> +- hardware address of the function to set.
> +
>  .SH "EXAMPLES"
>  .PP
>  devlink port show
> @@ -135,6 +151,11 @@ devlink port health show pci/0000:01:00.0/1 reporter
> tx  .RS 4  Shows status and configuration of tx reporter registered on
> pci/0000:01:00.0/1 devlink port.
>  .RE
> +.PP
> +devlink port function set pci/0000:01:00.0/1 hw_addr 00:00:00:11:22:33
> +.RS 4 Configure hardware address of the PCI function represented by
> +devlink port.
> +.RE
> 
>  .SH SEE ALSO
>  .BR devlink (8),
> --
> 2.26.2
Parav Pandit Jan. 29, 2021, 6:35 a.m. UTC | #2
Hi David, Stephen,

> From: Parav Pandit <parav@nvidia.com>
> Sent: Tuesday, January 26, 2021 6:54 PM
> 
> Hi Stephen,
> 
> > From: Parav Pandit <parav@nvidia.com>
> > Sent: Friday, January 22, 2021 10:32 AM
> >
> > Extended devlink-port man page for synopsis, description and example
> > for setting devlink port function attribute.
> >
> > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > Reviewed-by: Jiri Pirko <jiri@nvidia.com>
> 
> Can you please review this short update?
Please discard this patch, I am sending the subfunction patches and this piece is covered in it now.
diff mbox series

Patch

diff --git a/man/man8/devlink-port.8 b/man/man8/devlink-port.8
index 966faae6..7e2dc110 100644
--- a/man/man8/devlink-port.8
+++ b/man/man8/devlink-port.8
@@ -46,6 +46,12 @@  devlink-port \- devlink port configuration
 .ti -8
 .B devlink port help
 
+.ti -8
+.BR "devlink port function set "
+.RI "[ "
+.BR "hw_addr "
+.RI "ADDR ]"
+
 .SH "DESCRIPTION"
 .SS devlink port set - change devlink port attributes
 
@@ -99,6 +105,16 @@  If this argument is omitted all ports are listed.
 Is an alias for
 .BR devlink-health (8).
 
+.SS devlink port function set - Set the port function attribute.
+
+.PP
+.B "DEV/PORT_INDEX"
+- specifies the devlink port to operate on.
+
+.PP
+.BI hw_addr " ADDR"
+- hardware address of the function to set.
+
 .SH "EXAMPLES"
 .PP
 devlink port show
@@ -135,6 +151,11 @@  devlink port health show pci/0000:01:00.0/1 reporter tx
 .RS 4
 Shows status and configuration of tx reporter registered on pci/0000:01:00.0/1 devlink port.
 .RE
+.PP
+devlink port function set pci/0000:01:00.0/1 hw_addr 00:00:00:11:22:33
+.RS 4
+Configure hardware address of the PCI function represented by devlink port.
+.RE
 
 .SH SEE ALSO
 .BR devlink (8),