doc: update usage field for port-queue
PATCH 2/2 doc: update usage field for port-queue
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 <[email protected]>
--- 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(-)
doc/guides/sample_app_ug/l2_forward_crypto.rst +3 -1
@@ -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 -----------
doc/guides/sample_app_ug/l2_forward_job_stats.rst +5 -1
@@ -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 -----------
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +5 -1
@@ -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 -----------
Signature · 1 line
2.17.1
PATCH 1/1 doc: fix description of maximum rx queues per lcore option
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 <[email protected]>
Signed-off-by Stephen Hemminger <[email protected]>
--- 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(-)
doc/guides/sample_app_ug/ip_frag.rst +1 -1
@@ -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:
doc/guides/sample_app_ug/keep_alive.rst +1 -1
@@ -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)
doc/guides/sample_app_ug/l2_forward_crypto.rst +1 -1
@@ -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.
doc/guides/sample_app_ug/l2_forward_event.rst +1 -1
@@ -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).
doc/guides/sample_app_ug/l2_forward_job_stats.rst +1 -1
@@ -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.
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +1 -1
@@ -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)
doc/guides/sample_app_ug/link_status_intr.rst +1 -1
@@ -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)
Signature · 1 line
2.39.2
Thomas Monjalon
AppliedRe: [PATCH] doc: fix description of maximum rx queues per lcore option
13/06/2023 18:15, Stephen Hemminger:
Quoted 6 lines
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 <[email protected]>Signed-off-by Stephen Hemminger <[email protected]>
Applied, thanks.