Improve the sample applications introduction documentation: - use consistent title capitalization in cross-references - replace contractions with full forms - use I/O instead of IO - fix punctuation and grammar
Signed-off-by: Stephen Hemminger <[email protected]> --- doc/guides/sample_app_ug/intro.rst | 54 +++++++++++++++--------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst index a19c0b8c13..25a15966db 100644 --- a/doc/guides/sample_app_ug/intro.rst +++ b/doc/guides/sample_app_ug/intro.rst @@ -4,8 +4,8 @@ Introduction to the DPDK Sample Applications ============================================ -The DPDK Sample Applications are small standalone applications that -demonstrate various features of DPDK. They can be considered as a cookbook of +The DPDK sample applications are small standalone applications that +demonstrate various features of DPDK. They can be considered a cookbook of DPDK features. Users interested in getting started with DPDK can take the applications, try out the features, and then extend them to fit their needs. @@ -14,8 +14,8 @@ Running Sample Applications --------------------------- Some sample applications may have their own command-line parameters described in -their respective guides. However, they all also share the same EAL parameters. -Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>` +their respective guides. However, they also all share the same EAL parameters. +Refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>` or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for a list of available EAL command-line options. @@ -32,8 +32,8 @@ examples are highlighted below. * :doc:`Hello World<hello_world>`: As with most introductions to a programming framework, a good place to start is with the Hello World application. The Hello World example sets up the DPDK Environment Abstraction - Layer (EAL), and prints a simple "Hello World" message to each of the DPDK - enabled cores. This application doesn't do any packet forwarding, but it is a + Layer (EAL) and prints a simple "Hello World" message to each of the DPDK + enabled cores. This application does not do any packet forwarding, but it is a good way to test if the DPDK environment is compiled and set up properly. * :doc:`Basic Forwarding/Skeleton Application<skeleton>`: The Basic @@ -41,25 +41,25 @@ examples are highlighted below. basic packet forwarding with DPDK. This allows you to test if your network interfaces are working with DPDK. -* :doc:`Network Layer 2 forwarding<l2_forward_real_virtual>`: The Network Layer 2 - forwarding, or ``l2fwd`` application does forwarding based on Ethernet MAC +* :doc:`Network Layer 2 Forwarding<l2_forward_real_virtual>`: The Network Layer 2 + forwarding, or ``l2fwd`` application, does forwarding based on Ethernet MAC addresses like a simple switch. -* :doc:`Network Layer 2 forwarding<l2_forward_event>`: The Network Layer 2 - forwarding, or ``l2fwd-event`` application does forwarding based on Ethernet MAC - addresses like a simple switch. It demonstrates usage of poll and event mode - IO mechanism under a single application. +* :doc:`Network Layer 2 Forwarding with Event Mode<l2_forward_event>`: The Network + Layer 2 forwarding, or ``l2fwd-event`` application, does forwarding based on + Ethernet MAC addresses like a simple switch. It demonstrates usage of poll and + event mode I/O mechanisms under a single application. -* :doc:`Network Layer 3 forwarding<l3_forward>`: The Network Layer3 - forwarding, or ``l3fwd`` application does forwarding based on Internet - Protocol, IPv4 or IPv6 like a simple router. +* :doc:`Network Layer 3 Forwarding<l3_forward>`: The Network Layer 3 + forwarding, or ``l3fwd`` application, does forwarding based on Internet + Protocol (IPv4 or IPv6) like a simple router. -* :doc:`Network Layer 3 forwarding Graph<l3_forward_graph>`: The Network Layer3 - forwarding Graph, or ``l3fwd_graph`` application does forwarding based on IPv4 - like a simple router with DPDK Graph framework. +* :doc:`Network Layer 3 Forwarding Graph<l3_forward_graph>`: The Network Layer 3 + forwarding Graph, or ``l3fwd_graph`` application, does forwarding based on IPv4 + like a simple router using the DPDK Graph framework. -* :doc:`Hardware packet copying<dma>`: The Hardware packet copying, - or ``dmafwd`` application demonstrates how to use DMAdev library for +* :doc:`Hardware Packet Copying<dma>`: The hardware packet copying, + or ``dmafwd`` application, demonstrates how to use the DMAdev library for copying packets between two threads. * :doc:`Packet Distributor<dist_app>`: The Packet Distributor @@ -70,27 +70,27 @@ examples are highlighted below. multi-process application shows how two DPDK processes can work together using queues and memory pools to share information. -* :doc:`RX/TX callbacks Application<rxtx_callbacks>`: The RX/TX +* :doc:`Rx/Tx Callbacks Application<rxtx_callbacks>`: The Rx/Tx callbacks sample application is a packet forwarding application that demonstrates the use of user-defined callbacks on received and transmitted - packets. The application calculates the latency of a packet between RX - (packet arrival) and TX (packet transmission) by adding callbacks to the RX - and TX packet processing functions. + packets. The application calculates the latency of a packet between Rx + (packet arrival) and Tx (packet transmission) by adding callbacks to the Rx + and Tx packet processing functions. * :doc:`IPsec Security Gateway<ipsec_secgw>`: The IPsec Security Gateway application is a minimal example of something closer to a real world example. This is also a good example of an application using the DPDK Cryptodev framework. -* :doc:`Precision Time Protocol (PTP) client<ptpclient>`: The PTP +* :doc:`Precision Time Protocol (PTP) Client<ptpclient>`: The PTP client is another minimal implementation of a real world application. In this case, the application is a PTP client that communicates with a PTP time transmitter to synchronize time on a Network Interface Card (NIC) using the - IEEE1588 protocol. + IEEE 1588 protocol. * :doc:`Quality of Service (QoS) Scheduler<qos_scheduler>`: The QoS Scheduler application demonstrates the use of DPDK to provide QoS scheduling. There are many more examples shown in the following chapters. Each of the -documented sample applications show how to compile, configure and run the +documented sample applications shows how to compile, configure, and run the application, as well as explaining the main functionality of the code. -- 2.51.0
