[dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue

[dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue

[Vipin Varghese]

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

[dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue

[Vipin Varghese]

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

[PATCH] doc: fix description of maximum rx queues per lcore option

[Stephen Hemminger]

Several commands have a -q option but the description in
the documentation was unclear. It is the upper limit on
the number of queues per lcore.

Suggested-by: Vipin Varghese <vipin.varghese@intel.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/sample_app_ug/ip_frag.rst                 | 2 +-
 doc/guides/sample_app_ug/keep_alive.rst              | 2 +-
 doc/guides/sample_app_ug/l2_forward_crypto.rst       | 2 +-
 doc/guides/sample_app_ug/l2_forward_event.rst        | 2 +-
 doc/guides/sample_app_ug/l2_forward_job_stats.rst    | 2 +-
 doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 2 +-
 doc/guides/sample_app_ug/link_status_intr.rst        | 2 +-
 7 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/guides/sample_app_ug/ip_frag.rst b/doc/guides/sample_app_ug/ip_frag.rst
index 5fdeb2a84e0c..dd15033a4a08 100644
--- a/doc/guides/sample_app_ug/ip_frag.rst
+++ b/doc/guides/sample_app_ug/ip_frag.rst
@@ -59,7 +59,7 @@ where:
 
 *   -p PORTMASK is a hexadecimal bitmask of ports to configure
 
-*   -q NQ is the number of queue (=ports) per lcore (the default is 1)
+*   -q NQ: Maximum number of queues per lcore (default is 1)
 
 To run the example in linux environment with 2 lcores (2,4) over 2 ports(0,2) with 1 RX queue per lcore:
 
diff --git a/doc/guides/sample_app_ug/keep_alive.rst b/doc/guides/sample_app_ug/keep_alive.rst
index a907ff36a192..a7da795907a3 100644
--- a/doc/guides/sample_app_ug/keep_alive.rst
+++ b/doc/guides/sample_app_ug/keep_alive.rst
@@ -56,7 +56,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``: Maximum number of queues per lcore (default is 1)
 
 * ``K PERIOD``: Heartbeat check period in ms(5ms default; 86400 max)
 
diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst b/doc/guides/sample_app_ug/l2_forward_crypto.rst
index ce49eab96fe2..ed3c38f3ed6f 100644
--- a/doc/guides/sample_app_ug/l2_forward_crypto.rst
+++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst
@@ -56,7 +56,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: Maximum number of queues per lcore (default is 1)
 
 *   s: manage all ports from a single core.
 
diff --git a/doc/guides/sample_app_ug/l2_forward_event.rst b/doc/guides/sample_app_ug/l2_forward_event.rst
index 904f6f1a4a26..f914fdc14d97 100644
--- a/doc/guides/sample_app_ug/l2_forward_event.rst
+++ b/doc/guides/sample_app_ug/l2_forward_event.rst
@@ -63,7 +63,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: Maximum number of queues per lcore (default is 1)
 
 *   --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default).
 
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 349ad56ec6b6..53a12351d67a 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: Maximum number of queues per lcore (default is 1)
 
 *   l: Use locale thousands separator when formatting big numbers.
 
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 aeeda7059cb6..8d1958aa7001 100644
--- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
+++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
@@ -106,7 +106,7 @@ where,
     Without this option, only packets with the MAC destination address
     set to the Ethernet address of the port are accepted.
 
-*   q NQ: A number of queues (=ports) per lcore (default is 1)
+*   q NQ: Maximum number of queues per lcore (default is 1)
 
 *   --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)
 
diff --git a/doc/guides/sample_app_ug/link_status_intr.rst b/doc/guides/sample_app_ug/link_status_intr.rst
index a4c0712bd92f..34b8b2e13186 100644
--- a/doc/guides/sample_app_ug/link_status_intr.rst
+++ b/doc/guides/sample_app_ug/link_status_intr.rst
@@ -45,7 +45,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: Maximum number of queues per lcore (default is 1)
 
 *   -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default)
 
-- 
2.39.2

Re: [PATCH] doc: fix description of maximum rx queues per lcore option

[Thomas Monjalon]

13/06/2023 18:15, Stephen Hemminger:
> Several commands have a -q option but the description in
> the documentation was unclear. It is the upper limit on
> the number of queues per lcore.
> 
> Suggested-by: Vipin Varghese <vipin.varghese@intel.com>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

Applied, thanks.