[PATCH] net/vhost: improve devargs documentation

[PATCH] net/vhost: improve devargs documentation

[Maxime Coquelin]

This patch adds missing 'client' devarg documentation and
improve other devargs.

Bugzilla ID: 1603

Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
 doc/guides/nics/vhost.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/vhost.rst b/doc/guides/nics/vhost.rst
index 39c6fcff58..0013dc526f 100644
--- a/doc/guides/nics/vhost.rst
+++ b/doc/guides/nics/vhost.rst
@@ -32,13 +32,18 @@ The user can specify below arguments in `--vdev` option.
 
 #.  ``iface``:
 
-    It is used to specify a path to connect to a QEMU virtio-net device.
+    It is used to specify a path to connect to a Vhost-user frontend or VDUSE device.
 
 #.  ``queues``:
 
-    It is used to specify the number of queues virtio-net device has.
+    It is used to specify the number of queue pairs virtio-net device has.
     (Default: 1)
 
+#.  ``client``:
+
+   It is used to specify whether the Vhost PMD acts as client or server.
+   (Default: 0 (server))
+
 #.  ``iommu-support``:
 
     It is used to enable iommu support in vhost library.
-- 
2.47.0

Re: [PATCH] net/vhost: improve devargs documentation

[David Marchand]

On Fri, Dec 20, 2024 at 3:58 PM Maxime Coquelin
<maxime.coquelin@redhat.com> wrote:
>
> This patch adds missing 'client' devarg documentation and
> improve other devargs.
>
> Bugzilla ID: 1603
>
> Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>

This fix lgtm.

Note that legacy-ol-flags is not referenced in the pmdinfo usage
string (RTE_PMD_REGISTER_PARAM_STRING).


-- 
David Marchand

Re: [PATCH] net/vhost: improve devargs documentation

[Chenbo Xia]

> On Dec 20, 2024, at 22:58, Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
> 
> External email: Use caution opening links or attachments
> 
> 
> This patch adds missing 'client' devarg documentation and
> improve other devargs.
> 
> Bugzilla ID: 1603
> 
> Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
> doc/guides/nics/vhost.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/vhost.rst b/doc/guides/nics/vhost.rst
> index 39c6fcff58..0013dc526f 100644
> --- a/doc/guides/nics/vhost.rst
> +++ b/doc/guides/nics/vhost.rst
> @@ -32,13 +32,18 @@ The user can specify below arguments in `--vdev` option.
> 
> #.  ``iface``:
> 
> -    It is used to specify a path to connect to a QEMU virtio-net device.
> +    It is used to specify a path to connect to a Vhost-user frontend or VDUSE device.
> 
> #.  ``queues``:
> 
> -    It is used to specify the number of queues virtio-net device has.
> +    It is used to specify the number of queue pairs virtio-net device has.
>     (Default: 1)
> 
> +#.  ``client``:
> +
> +   It is used to specify whether the Vhost PMD acts as client or server.
> +   (Default: 0 (server))
> +
> #.  ``iommu-support``:
> 
>     It is used to enable iommu support in vhost library.
> —
> 2.47.0
> 

Reviewed-by: Chenbo Xia <chenbox@nvidia.com>