* [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue
@ 2019-05-07 6:49 Vipin Varghese
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
0 siblings, 2 replies; 4+ messages in thread
From: Vipin Varghese @ 2019-05-07 6:49 UTC (permalink / raw)
To: dev, marko.kovacevic, john.mcnamara, ramirose,
pablo.de.lara.guarch, bruce.richardson,
v1-0001-app-update-usage-field.patch
Cc: sanjay.padubidri, 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
^ permalink raw reply [flat|nested] 4+ messages in thread* [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue
2019-05-07 6:49 [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue Vipin Varghese
@ 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
1 sibling, 0 replies; 4+ messages in thread
From: Vipin Varghese @ 2019-05-07 6:49 UTC (permalink / raw)
To: dev, marko.kovacevic, john.mcnamara, ramirose,
pablo.de.lara.guarch, bruce.richardson,
v1-0001-app-update-usage-field.patch
Cc: sanjay.padubidri, 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
^ permalink raw reply [flat|nested] 4+ messages in thread* [PATCH] doc: fix description of maximum rx queues per lcore option
2019-05-07 6:49 [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue Vipin Varghese
2019-05-07 6:49 ` Vipin Varghese
@ 2023-06-13 16:15 ` Stephen Hemminger
2024-07-29 21:02 ` Thomas Monjalon
1 sibling, 1 reply; 4+ messages in thread
From: Stephen Hemminger @ 2023-06-13 16:15 UTC (permalink / raw)
To: dev
Cc: Stephen Hemminger, Vipin Varghese, Konstantin Ananyev,
Sunil Kumar Kori, Pavan Nikhilesh, Bruce Richardson
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-07-29 21:02 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-07 6:49 [dpdk-dev] [PATCH v1 2/2] doc: update usage field for port-queue Vipin Varghese
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
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).