From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6D81F45EFA; Fri, 20 Dec 2024 15:58:10 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2521F40156; Fri, 20 Dec 2024 15:58:10 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 4B06E4003C for ; Fri, 20 Dec 2024 15:58:09 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734706688; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=67hXzw+QBKqtMFQ1L3oo4CTU4dHujTu08+++dhJ2ius=; b=T02U4E8db9Ku5V1y1ZBZDBsv5SW8ACi0EpWEez2JhxKdVr3Jlvs7jQVcsD9kmcSxBVEeUU CYHjHw7Xg/5kJa/ML33oUsBPLGdY20GO4A7o7q9MGgDhCc1TeRX/GC4u4sA69GMaRxD4Gc /XsL9/9SI8GF0KOue2MlKC7WiluEoXQ= Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-48-2duyIurdOU25bV4vEXU2IQ-1; Fri, 20 Dec 2024 09:58:07 -0500 X-MC-Unique: 2duyIurdOU25bV4vEXU2IQ-1 X-Mimecast-MFC-AGG-ID: 2duyIurdOU25bV4vEXU2IQ Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A7DF719560AA; Fri, 20 Dec 2024 14:58:06 +0000 (UTC) Received: from max-p1.redhat.com (unknown [10.39.208.6]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 7C3BE30044C1; Fri, 20 Dec 2024 14:58:04 +0000 (UTC) From: Maxime Coquelin To: dev@dpdk.org, chenbox@nvidia.com, david.marchand@redhat.com Cc: Maxime Coquelin Subject: [PATCH] net/vhost: improve devargs documentation Date: Fri, 20 Dec 2024 15:58:02 +0100 Message-ID: <20241220145802.3851767-1-maxime.coquelin@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: ORRZJ5tUEW4x7bGXxy2MKXh_Z6whZxSiquFtCXVfacw_1734706687 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org This patch adds missing 'client' devarg documentation and improve other devargs. Bugzilla ID: 1603 Signed-off-by: Maxime Coquelin --- 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