From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 19/29] doc/guides: improve sample applications introduction
Date: Wed, 14 Jan 2026 14:22:00 -0800 [thread overview]
Message-ID: <20260114222458.87119-20-stephen@networkplumber.org> (raw)
In-Reply-To: <20260114222458.87119-1-stephen@networkplumber.org>
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 <stephen@networkplumber.org>
---
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
next prev parent reply other threads:[~2026-01-14 22:27 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-14 22:21 [PATCH 00/29] doc/guides: sample application documentation improvements Stephen Hemminger
2026-01-14 22:21 ` [PATCH 01/29] examples/timer: correct documentation errors Stephen Hemminger
2026-01-14 22:21 ` [PATCH 02/29] examples/packet_ordering: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 03/29] examples/service_cores: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 04/29] examples/rxtx_callbacks: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 05/29] examples/ip_fragmentation: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 06/29] examples/eventdev_pipeline: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 07/29] doc/guides: improve VMDq sample application documentation Stephen Hemminger
2026-01-14 22:21 ` [PATCH 08/29] examples/distributor: correct documentation errors Stephen Hemminger
2026-01-14 22:21 ` [PATCH 09/29] examples/ipv4_multicast: correct documentation typo Stephen Hemminger
2026-01-14 22:21 ` [PATCH 10/29] examples/test_pipeline: correct documentation errors Stephen Hemminger
2026-01-14 22:21 ` [PATCH 11/29] examples/qos: improve sample application documentation Stephen Hemminger
2026-01-14 22:21 ` [PATCH 12/29] examples/vhost: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 13/29] examples/ptpclient: " Stephen Hemminger
2026-01-14 22:21 ` [PATCH 14/29] doc/guides: improve vDPA sample application guide Stephen Hemminger
2026-01-14 22:21 ` [PATCH 15/29] doc/guides: improve command line sample app guide Stephen Hemminger
2026-01-14 22:21 ` [PATCH 16/29] doc/guides: improve DMA " Stephen Hemminger
2026-01-19 0:47 ` fengchengwen
2026-01-14 22:21 ` [PATCH 17/29] doc/guides: improve FIPS validation " Stephen Hemminger
2026-01-19 5:59 ` [EXTERNAL] " Gowrishankar Muthukrishnan
2026-01-14 22:21 ` [PATCH 18/29] doc/guides: improve Hello World " Stephen Hemminger
2026-01-14 22:22 ` Stephen Hemminger [this message]
2026-01-14 22:22 ` [PATCH 20/29] doc/guides: improve IP pipeline " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 21/29] doc/guides: improve IP reassembly " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 22/29] doc/guides: improve IPsec security gateway guide Stephen Hemminger
2026-01-14 22:22 ` [PATCH 23/29] doc/guides: improve link status interrupt sample app guide Stephen Hemminger
2026-01-14 22:22 ` [PATCH 24/29] doc/guides: improve multi-process " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 25/29] doc/guides: improve pipeline " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 26/29] doc/guides: improve VM power management " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 27/29] doc/guides: improve keep alive " Stephen Hemminger
2026-01-14 22:22 ` [PATCH 28/29] fix ipsec gw Stephen Hemminger
2026-01-14 23:00 ` Stephen Hemminger
2026-01-14 22:22 ` [PATCH 29/29] fix pipeline Stephen Hemminger
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=20260114222458.87119-20-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.