Address grammar and clarity issues in packet ordering sample documentation: - Change "enables output the" to "enables output of the" - Clarify port mask description from "either 1 or even enabled port numbers" to "either 1 or an even number of enabled ports"
Signed-off-by: Stephen Hemminger <[email protected]> --- doc/guides/sample_app_ug/packet_ordering.rst | 23 +++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/guides/sample_app_ug/packet_ordering.rst b/doc/guides/sample_app_ug/packet_ordering.rst index f96c0ad697..057dd932d4 100644 --- a/doc/guides/sample_app_ug/packet_ordering.rst +++ b/doc/guides/sample_app_ug/packet_ordering.rst @@ -4,29 +4,29 @@ Packet Ordering Application ============================ -The Packet Ordering sample app simply shows the impact of reordering a stream. -It's meant to stress the library with different configurations for performance. +The Packet Ordering sample application shows the impact of reordering a stream. +It is meant to stress the library with different configurations for performance. Overview -------- The application uses at least three CPU cores: -* RX core (main core) receives traffic from the NIC ports and feeds Worker +* The RX core (main core) receives traffic from the NIC ports and feeds Worker cores with traffic through SW queues. -* Worker (worker core) basically do some light work on the packet. - Currently it modifies the output port of the packet for configurations with +* The Worker (worker core) does some light work on the packet. + Currently, it modifies the output port of the packet for configurations with more than one port enabled. -* TX Core (worker core) receives traffic from Worker cores through software queues, +* The TX Core (worker core) receives traffic from Worker cores through software queues, inserts out-of-order packets into reorder buffer, extracts ordered packets from the reorder buffer and sends them to the NIC ports for transmission. Compiling the Application ------------------------- -To compile the sample application see :doc:`compiling`. +To compile the sample application, see :doc:`compiling`. The application is located in the ``packet_ordering`` sub-directory. @@ -36,6 +36,9 @@ Running the Application Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options. +Explanation +----------- + Application Command Line ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -50,12 +53,12 @@ The -l EAL corelist option has to contain at least 3 CPU cores. The first CPU core in the core mask is the main core and would be assigned to RX core, the last to TX core and the rest to Worker cores. -The PORTMASK parameter must contain either 1 or even enabled port numbers. +The PORTMASK parameter must contain either 1 or an even number of enabled ports. When setting more than 1 port, traffic would be forwarded in pairs. For example, if we enable 4 ports, traffic from port 0 to 1 and from 1 to 0, then the other pair from 2 to 3 and from 3 to 2, having [0,1] and [2,3] pairs. -The disable-reorder long option does, as its name implies, disable the reordering +The disable-reorder long option, as its name implies, disables the reordering of traffic, which should help evaluate reordering performance impact. -The insight-worker long option enables output the packet statistics of each worker thread. +The insight-worker long option enables output of the packet statistics of each worker thread. -- 2.51.0
