From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 00/15] doc: clean up sample application guides
Date: Thu, 11 Jun 2026 14:18:39 -0700 [thread overview]
Message-ID: <20260611212119.1026721-1-stephen@networkplumber.org> (raw)
In-Reply-To: <20250216230903.124496-1-nandinipersad361@gmail.com>
This series revises the sample application user guides for clarity,
grammar, and formatting consistency. Changes are documentation only:
wording is simplified, command-line options are normalised, Linux and
Ethernet capitalisation is corrected, and definition lists replace
ad hoc bullet lists where a term/description structure fits.
This work started from edits by Nandini Persad and was extended and
reworked across the rest of the sample application guides.
Stephen Hemminger (15):
doc: cleanups to bbdev sample application
doc: cleanup cmd_line example documentation
doc: cleanup the distribution sample application guide
doc: improve structure and clarity of compiling guide
doc: improve clarity and consistency in DMA sample app guide
doc: correct capitalization and formatting in ethtool guide
doc: improve clarity in eventdev, FIPS, and flow filtering
doc: enhance hello_world, intro, IP frag and pipeline
doc: improve IP reassembly, IPsec, multicast, and keep-alive
doc: enhance L2 forwarding sample application guides
doc: enhance multi-process, NTB, ordering, and PTP guides
doc: improve QoS, callbacks, EFD, and service cores guides
doc: enhance skeleton, pipeline, timer, and vhost guides
doc: improve vhost, VM power, and VMDq sample guides
doc: correct grammar and punctuation consistency issues
doc/guides/sample_app_ug/bbdev_app.rst | 73 +++--
doc/guides/sample_app_ug/cmd_line.rst | 37 +--
doc/guides/sample_app_ug/compiling.rst | 84 +++---
doc/guides/sample_app_ug/dist_app.rst | 52 ++--
doc/guides/sample_app_ug/dma.rst | 60 ++--
doc/guides/sample_app_ug/ethtool.rst | 18 +-
.../sample_app_ug/eventdev_pipeline.rst | 51 ++--
doc/guides/sample_app_ug/fips_validation.rst | 65 +++--
doc/guides/sample_app_ug/flow_filtering.rst | 51 ++--
doc/guides/sample_app_ug/hello_world.rst | 8 +-
doc/guides/sample_app_ug/intro.rst | 34 +--
doc/guides/sample_app_ug/ip_frag.rst | 46 +--
doc/guides/sample_app_ug/ip_pipeline.rst | 109 ++++----
doc/guides/sample_app_ug/ip_reassembly.rst | 57 ++--
doc/guides/sample_app_ug/ipsec_secgw.rst | 128 ++++-----
doc/guides/sample_app_ug/ipv4_multicast.rst | 26 +-
doc/guides/sample_app_ug/keep_alive.rst | 12 +-
doc/guides/sample_app_ug/l2_forward_cat.rst | 34 +--
.../sample_app_ug/l2_forward_crypto.rst | 70 +++--
doc/guides/sample_app_ug/l2_forward_event.rst | 20 +-
.../sample_app_ug/l2_forward_job_stats.rst | 46 ++-
.../sample_app_ug/l2_forward_macsec.rst | 38 +--
.../sample_app_ug/l2_forward_real_virtual.rst | 4 +-
doc/guides/sample_app_ug/link_status_intr.rst | 2 +-
doc/guides/sample_app_ug/multi_process.rst | 49 ++--
doc/guides/sample_app_ug/ntb.rst | 4 +-
doc/guides/sample_app_ug/packet_ordering.rst | 42 +--
doc/guides/sample_app_ug/pipeline.rst | 26 +-
doc/guides/sample_app_ug/ptp_tap_relay_sw.rst | 2 +-
doc/guides/sample_app_ug/ptpclient.rst | 51 ++--
doc/guides/sample_app_ug/qos_metering.rst | 11 +-
doc/guides/sample_app_ug/qos_scheduler.rst | 16 +-
doc/guides/sample_app_ug/rxtx_callbacks.rst | 11 +-
doc/guides/sample_app_ug/server_node_efd.rst | 4 +-
doc/guides/sample_app_ug/service_cores.rst | 67 ++---
doc/guides/sample_app_ug/skeleton.rst | 8 +-
doc/guides/sample_app_ug/test_pipeline.rst | 17 +-
doc/guides/sample_app_ug/timer.rst | 19 +-
doc/guides/sample_app_ug/vdpa.rst | 51 ++--
doc/guides/sample_app_ug/vhost.rst | 178 ++++++------
doc/guides/sample_app_ug/vhost_blk.rst | 66 +++--
doc/guides/sample_app_ug/vhost_crypto.rst | 64 ++---
.../sample_app_ug/vm_power_management.rst | 262 ++++++++----------
.../sample_app_ug/vmdq_dcb_forwarding.rst | 101 ++++---
doc/guides/sample_app_ug/vmdq_forwarding.rst | 38 ++-
45 files changed, 1121 insertions(+), 1091 deletions(-)
--
2.53.0
next prev parent reply other threads:[~2026-06-11 21:21 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-27 17:47 [PATCH] doc: reword sample application guides Nandini Persad
2025-02-16 23:09 ` [PATCH v2] " Nandini Persad
2025-02-20 12:26 ` Burakov, Anatoly
2026-06-11 21:18 ` Stephen Hemminger [this message]
2026-06-11 21:18 ` [PATCH 01/15] doc: cleanups to bbdev sample application Stephen Hemminger
2026-06-11 21:18 ` [PATCH 02/15] doc: cleanup cmd_line example documentation Stephen Hemminger
2026-06-11 21:18 ` [PATCH 03/15] doc: cleanup the distribution sample application guide Stephen Hemminger
2026-06-11 21:18 ` [PATCH 04/15] doc: improve structure and clarity of compiling guide Stephen Hemminger
2026-06-11 21:18 ` [PATCH 05/15] doc: improve clarity and consistency in DMA sample app guide Stephen Hemminger
2026-06-15 9:50 ` fengchengwen
2026-06-11 21:18 ` [PATCH 06/15] doc: correct capitalization and formatting in ethtool guide Stephen Hemminger
2026-06-11 21:18 ` [PATCH 07/15] doc: improve clarity in eventdev, FIPS, and flow filtering Stephen Hemminger
2026-06-11 21:18 ` [PATCH 08/15] doc: enhance hello_world, intro, IP frag and pipeline Stephen Hemminger
2026-06-11 21:18 ` [PATCH 09/15] doc: improve IP reassembly, IPsec, multicast, and keep-alive Stephen Hemminger
2026-06-12 10:06 ` Radu Nicolau
2026-06-11 21:18 ` [PATCH 10/15] doc: enhance L2 forwarding sample application guides Stephen Hemminger
2026-06-11 21:18 ` [PATCH 11/15] doc: enhance multi-process, NTB, ordering, and PTP guides Stephen Hemminger
2026-06-11 21:18 ` [PATCH 12/15] doc: improve QoS, callbacks, EFD, and service cores guides Stephen Hemminger
2026-06-11 21:18 ` [PATCH 13/15] doc: enhance skeleton, pipeline, timer, and vhost guides Stephen Hemminger
2026-06-11 21:18 ` [PATCH 14/15] doc: improve vhost, VM power, and VMDq sample guides Stephen Hemminger
2026-06-11 21:18 ` [PATCH 15/15] doc: correct grammar and punctuation consistency issues Stephen Hemminger
2026-06-12 10:06 ` Radu Nicolau
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=20260611212119.1026721-1-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox