diff mbox series

vdpa: Update man page with added support to configure max vq pair

Message ID 20220315131358.7210-1-elic@nvidia.com (mailing list archive)
State Accepted
Commit 8130653dabe6726b46b7b19c31d85e33a67175e3
Delegated to: David Ahern
Headers show
Series vdpa: Update man page with added support to configure max vq pair | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Eli Cohen March 15, 2022, 1:13 p.m. UTC
Update man page to include information how to configure the max
virtqueue pairs for a vdpa device when creating one.

Signed-off-by: Eli Cohen <elic@nvidia.com>
---
 man/man8/vdpa-dev.8 | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

patchwork-bot+netdevbpf@kernel.org March 17, 2022, 1:10 a.m. UTC | #1
Hello:

This patch was applied to iproute2/iproute2-next.git (main)
by David Ahern <dsahern@kernel.org>:

On Tue, 15 Mar 2022 15:13:58 +0200 you wrote:
> Update man page to include information how to configure the max
> virtqueue pairs for a vdpa device when creating one.
> 
> Signed-off-by: Eli Cohen <elic@nvidia.com>
> ---
>  man/man8/vdpa-dev.8 | 6 ++++++
>  1 file changed, 6 insertions(+)

Here is the summary with links:
  - vdpa: Update man page with added support to configure max vq pair
    https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=8130653dabe6

You are awesome, thank you!
Jason Wang March 17, 2022, 3:39 a.m. UTC | #2
On Tue, Mar 15, 2022 at 9:14 PM Eli Cohen <elic@nvidia.com> wrote:
>
> Update man page to include information how to configure the max
> virtqueue pairs for a vdpa device when creating one.
>
> Signed-off-by: Eli Cohen <elic@nvidia.com>

Acked-by: Jason Wang <jasowang@redhat.com>

> ---
>  man/man8/vdpa-dev.8 | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/man/man8/vdpa-dev.8 b/man/man8/vdpa-dev.8
> index aa21ae3acbd8..432867c65182 100644
> --- a/man/man8/vdpa-dev.8
> +++ b/man/man8/vdpa-dev.8
> @@ -33,6 +33,7 @@ vdpa-dev \- vdpa device configuration
>  .I MGMTDEV
>  .RI "[ mac " MACADDR " ]"
>  .RI "[ mtu " MTU " ]"
> +.RI "[ max_vqp " MAX_VQ_PAIRS " ]"
>
>  .ti -8
>  .B vdpa dev del
> @@ -119,6 +120,11 @@ vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000
>  Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55 and mtu of 9000 bytes.
>  .RE
>  .PP
> +vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
> +.RS 4
> +Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs
> +.RE
> +.PP
>  vdpa dev del foo
>  .RS 4
>  Delete the vdpa device named foo which was previously created.
> --
> 2.35.1
>
Si-Wei Liu March 18, 2022, 4:27 p.m. UTC | #3
On 3/15/2022 6:13 AM, Eli Cohen wrote:
> Update man page to include information how to configure the max
> virtqueue pairs for a vdpa device when creating one.
>
> Signed-off-by: Eli Cohen <elic@nvidia.com>
> ---
>   man/man8/vdpa-dev.8 | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/man/man8/vdpa-dev.8 b/man/man8/vdpa-dev.8
> index aa21ae3acbd8..432867c65182 100644
> --- a/man/man8/vdpa-dev.8
> +++ b/man/man8/vdpa-dev.8
> @@ -33,6 +33,7 @@ vdpa-dev \- vdpa device configuration
>   .I MGMTDEV
>   .RI "[ mac " MACADDR " ]"
>   .RI "[ mtu " MTU " ]"
> +.RI "[ max_vqp " MAX_VQ_PAIRS " ]"
>   


Here it introduces the max_vqp option to the SYNOPSIS. I would be nice 
to describe what it means and which device type is applicable in the 
below section:

> .PP
> .BI mac " MACADDR"
> - specifies the mac address for the new vdpa device.
> This is applicable only for the network type of vdpa device. This is optional.
>
> .BI mtu " MTU"
> - specifies the mtu for the new vdpa device.
> This is applicable only for the network type of vdpa device. This is optional.
>

Otherwise looks good to me.

Reviewed-by: Si-Wei Liu <si-wei.liu@oracle.com>

Thanks,
-Siwei
>   .ti -8
>   .B vdpa dev del
> @@ -119,6 +120,11 @@ vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000
>   Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55 and mtu of 9000 bytes.
>   .RE
>   .PP
> +vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
> +.RS 4
> +Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs
> +.RE
> +.PP
>   vdpa dev del foo
>   .RS 4
>   Delete the vdpa device named foo which was previously created.
diff mbox series

Patch

diff --git a/man/man8/vdpa-dev.8 b/man/man8/vdpa-dev.8
index aa21ae3acbd8..432867c65182 100644
--- a/man/man8/vdpa-dev.8
+++ b/man/man8/vdpa-dev.8
@@ -33,6 +33,7 @@  vdpa-dev \- vdpa device configuration
 .I MGMTDEV
 .RI "[ mac " MACADDR " ]"
 .RI "[ mtu " MTU " ]"
+.RI "[ max_vqp " MAX_VQ_PAIRS " ]"
 
 .ti -8
 .B vdpa dev del
@@ -119,6 +120,11 @@  vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000
 Add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55 and mtu of 9000 bytes.
 .RE
 .PP
+vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
+.RS 4
+Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs
+.RE
+.PP
 vdpa dev del foo
 .RS 4
 Delete the vdpa device named foo which was previously created.