From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
Vipin Varghese <vipin.varghese@intel.com>,
Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>,
Sunil Kumar Kori <skori@marvell.com>,
Pavan Nikhilesh <pbhagavatula@marvell.com>,
Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH] doc: fix description of maximum rx queues per lcore option
Date: Tue, 13 Jun 2023 09:15:01 -0700 [thread overview]
Message-ID: <20230613161501.66990-1-stephen@networkplumber.org> (raw)
In-Reply-To: <20190507064948.34567-1-vipin.varghese@intel.com>
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
prev parent reply other threads:[~2023-06-13 16:15 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
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=20230613161501.66990-1-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=konstantin.v.ananyev@yandex.ru \
--cc=pbhagavatula@marvell.com \
--cc=skori@marvell.com \
--cc=vipin.varghese@intel.com \
/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).