[v1,2/2] doc: update usage field for port-queue

Message ID 20190507064948.34567-1-vipin.varghese@intel.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • [v1,1/2] app: update usage field
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Vipin Varghese May 7, 2019, 6:49 a.m.
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(-)

Patch

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
 -----------