All of lore.kernel.org
 help / color / mirror / Atom feed
From: Maxime Coquelin <maxime.coquelin@redhat.com>
To: dev@dpdk.org, chenbox@nvidia.com, david.marchand@redhat.com
Cc: Maxime Coquelin <maxime.coquelin@redhat.com>
Subject: [PATCH] net/vhost: improve devargs documentation
Date: Fri, 20 Dec 2024 15:58:02 +0100	[thread overview]
Message-ID: <20241220145802.3851767-1-maxime.coquelin@redhat.com> (raw)

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


             reply	other threads:[~2024-12-20 14:58 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-20 14:58 Maxime Coquelin [this message]
2024-12-23 13:12 ` [PATCH] net/vhost: improve devargs documentation David Marchand
2025-02-07  2:38 ` Chenbo Xia
2025-02-07 14:10 ` Maxime Coquelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241220145802.3851767-1-maxime.coquelin@redhat.com \
    --to=maxime.coquelin@redhat.com \
    --cc=chenbox@nvidia.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.