diff mbox series

doc: fix description of maximum rx queues per lcore option

Message ID 20230613161501.66990-1-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix description of maximum rx queues per lcore option |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS

Commit Message

Stephen Hemminger June 13, 2023, 4:15 p.m. UTC 
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(-)

Comments

Thomas Monjalon July 29, 2024, 9:02 p.m. UTC | #1 
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.
diff mbox series

Patch

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)