From patchwork Tue May 7 06:49:48 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Varghese, Vipin" X-Patchwork-Id: 53303 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 95DE62082; Tue, 7 May 2019 08:49:25 +0200 (CEST) Received: from mga06.intel.com (unknown [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 3A3471F28 for ; Tue, 7 May 2019 08:49:24 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 May 2019 23:49:23 -0700 X-ExtLoop1: 1 Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203]) by fmsmga006.fm.intel.com with ESMTP; 06 May 2019 23:49:20 -0700 From: Vipin Varghese To: dev@dpdk.org, marko.kovacevic@intel.com, john.mcnamara@intel.com, ramirose@gmail.com, pablo.de.lara.guarch@intel.com, bruce.richardson@intel.com, v1-0001-app-update-usage-field.patch@dpdk.org Cc: sanjay.padubidri@intel.com, Vipin Varghese Date: Tue, 7 May 2019 12:19:48 +0530 Message-Id: <20190507064948.34567-1-vipin.varghese@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Usage option q is reflect how many port-queue pair can run per lcore. Updating usage field to refelct port-queue is done for one RX and TX only. Signed-off-by: Vipin Varghese --- doc/guides/sample_app_ug/l2_forward_crypto.rst | 4 +++- doc/guides/sample_app_ug/l2_forward_job_stats.rst | 6 +++++- doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 6 +++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst b/doc/guides/sample_app_ug/l2_forward_crypto.rst index e8d52dad2..c6b4e900f 100644 --- a/doc/guides/sample_app_ug/l2_forward_crypto.rst +++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst @@ -55,7 +55,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure (default is all the ports) -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: A number of ports per lcore (default is 1) * s: manage all ports from single core @@ -180,6 +180,8 @@ and the Environment Abstraction Layer (EAL) options. * All crypto devices shall use the same session. + * DPDK port-queue pair configured is only one for both RX and TX. + Explanation ----------- diff --git a/doc/guides/sample_app_ug/l2_forward_job_stats.rst b/doc/guides/sample_app_ug/l2_forward_job_stats.rst index dfc1ed9ca..81951a04d 100644 --- a/doc/guides/sample_app_ug/l2_forward_job_stats.rst +++ b/doc/guides/sample_app_ug/l2_forward_job_stats.rst @@ -87,7 +87,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: A number of ports per lcore (default is 1) * l: Use locale thousands separator when formatting big numbers. @@ -101,6 +101,10 @@ thousands separator printing, issue the command: Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options. +.. note:: + + DPDK port-queue pair configured is only one for both RX and TX. + Explanation ----------- diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst index e5b28e425..d0da37db7 100644 --- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst +++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst @@ -97,7 +97,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: A number of ports per lcore (default is 1) * --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default). @@ -111,6 +111,10 @@ updating enabled, issue the command: Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options. +.. note:: + + DPDK port-queue pair configured is only one for both RX and TX. + Explanation -----------