DPDK patches and discussions
 help / color / mirror / Atom feed
From: Vipin Varghese <vipin.varghese@intel.com>
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 <vipin.varghese@intel.com>
Subject: [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue
Date: Tue,  7 May 2019 12:19:48 +0530	[thread overview]
Message-ID: <20190507064948.34567-1-vipin.varghese@intel.com> (raw)
Message-ID: <20190507064948.dtFkSeLNZnVfSvE4du36ui1UDe1_-On9wrwCr0OVp4w@z> (raw)

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 <vipin.varghese@intel.com>
---
 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
 -----------
 
-- 
2.17.1


             reply	other threads:[~2019-05-07  6:49 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-07  6:49 Vipin Varghese [this message]
2019-05-07  6:49 ` Vipin Varghese
2023-06-13 16:15 ` [PATCH] doc: fix description of maximum rx queues per lcore option Stephen Hemminger
2024-07-29 21:02   ` Thomas Monjalon
2019-05-07  6:51 [dpdk-dev] [PATCH v1 1/2] app: update usage field Vipin Varghese
2019-05-07  6:51 ` [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue Vipin Varghese
2019-05-07  6:51   ` Vipin Varghese
2019-05-07 15:07   ` Mcnamara, John
2019-05-07 15:07     ` Mcnamara, John
2019-07-08 19:45   ` Thomas Monjalon
2019-07-30 11:27     ` Mcnamara, John

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=20190507064948.34567-1-vipin.varghese@intel.com \
    --to=vipin.varghese@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=pablo.de.lara.guarch@intel.com \
    --cc=ramirose@gmail.com \
    --cc=sanjay.padubidri@intel.com \
    --cc=v1-0001-app-update-usage-field.patch@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).