From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH v5 00/54] doc: programmers guide corrections
Date: Sun, 18 Jan 2026 11:10:03 -0800 [thread overview]
Message-ID: <20260118191323.241013-1-stephen@networkplumber.org> (raw)
In-Reply-To: <20240513155911.31872-1-nandinipersad361@gmail.com>
This is a revision of earlier corrections to the programmers guide.
At this point, it is a collaborative work of myself (Stephen), the
technical writer (Nandini) and AI (Claude).
This patch series contains 54 patches that improves the
quality and clarity of DPDK programmer guide documentation. The changes
address grammar errors, typos, awkward phrasing, and consistency issues
across multiple documentation files.
The improvements include:
* Grammar corrections (subject-verb agreement, verb tenses, article usage)
* Typo fixes (field names, function names, general spelling)
* Clarity improvements (rephrasing awkward or unclear sentences)
* Consistency improvements (terminology, formatting)
* Minor whitespace and formatting corrections
Files affected include documentation for:
- argparse library
- service cores
- vhost library
- toeplitz hash
- writing efficient code
- Various other programmer guides
Stephen Hemminger (54):
doc: correct grammar and typos in argparse library guide
doc: correct grammar in service cores guide
doc: correct grammar and errors in trace library guide
doc: correct typos in log library guide
doc: correct errors in command-line library guide
doc: correct errors in trace library guide
doc: correct errors in stack library guide
doc: correct errors in RCU library guide
doc: correct grammar and formatting in ASan guide
doc: correct grammar and typos in bbdev guide
doc: correct grammar and formatting in bpf lib guide
doc: correct grammar and typos in meson build guide
doc: correct grammar and typos in cryptodev guide
doc: correct grammar and formatting in compressdev guide
doc: correct grammar in dmadev guide
doc: correct grammar in efd guide
doc: correct grammar in EAL guide
doc: correct double space in FIB guide
doc: correct grammar in GRO guide
doc: correct grammar in GSO guide
doc: correct typos and grammar in graph guide
doc: correct grammar in hash guide
doc: correct grammar and typos in IP fragment guide
doc: correct double spaces in IPsec guide
doc: correct grammar in lcore variables guide
doc: correct typo in link bonding guide
doc: correct grammar in LTO guide
doc: correct grammar in LPM guide
doc: correct grammar and typo in LPM6 guide
doc: correct grammar in introduction
doc: correct grammar in mbuf library guide
doc: correct grammar in membership library guide
doc: correct errors in mempool library guide
doc: correct style in meson unit tests guide
doc: correct errors in metrics library guide
doc: correct grammar in mldev library guide
doc: correct grammar in multi-process guide
doc: correct grammar in overview
doc: correct grammar in ACL library guide
doc: correct typos in packet distributor guide
doc: correct grammar in packet framework guide
doc: correct grammar in PDCP library guide
doc: correct grammar in pdump library guide
doc: correct typos in power management guide
doc: correct grammar in profiling guide
doc: correct errors in regexdev guide
doc: correct grammar in reorder library guide
doc: correct whitespace in RIB library guide
doc: correct incomplete sentence in ring library guide
doc: correct grammar in security library guide
doc: correct hyphenation in thread safety guide
doc: correct errors in toeplitz hash library guide
doc: correct errors in vhost library guide
doc: correct whitespace in efficient code guide
doc/guides/prog_guide/argparse_lib.rst | 24 +--
doc/guides/prog_guide/asan.rst | 14 +-
doc/guides/prog_guide/bbdev.rst | 6 +-
doc/guides/prog_guide/bpf_lib.rst | 46 +++++-
doc/guides/prog_guide/build-sdk-meson.rst | 10 +-
doc/guides/prog_guide/cmdline.rst | 42 ++---
doc/guides/prog_guide/compressdev.rst | 10 +-
doc/guides/prog_guide/cryptodev_lib.rst | 21 +--
doc/guides/prog_guide/dmadev.rst | 6 +-
doc/guides/prog_guide/efd_lib.rst | 8 +-
.../prog_guide/env_abstraction_layer.rst | 4 +-
doc/guides/prog_guide/fib_lib.rst | 2 +-
.../generic_receive_offload_lib.rst | 20 +--
.../generic_segmentation_offload_lib.rst | 2 +-
doc/guides/prog_guide/graph_lib.rst | 16 +-
doc/guides/prog_guide/hash_lib.rst | 4 +-
doc/guides/prog_guide/intro.rst | 4 +-
.../prog_guide/ip_fragment_reassembly_lib.rst | 12 +-
doc/guides/prog_guide/ipsec_lib.rst | 4 +-
doc/guides/prog_guide/lcore_var.rst | 2 +-
.../link_bonding_poll_mode_drv_lib.rst | 2 +-
doc/guides/prog_guide/log_lib.rst | 32 ++--
doc/guides/prog_guide/lpm6_lib.rst | 4 +-
doc/guides/prog_guide/lpm_lib.rst | 2 +-
doc/guides/prog_guide/lto.rst | 2 +-
doc/guides/prog_guide/mbuf_lib.rst | 26 ++--
doc/guides/prog_guide/member_lib.rst | 26 ++--
doc/guides/prog_guide/mempool_lib.rst | 8 +-
doc/guides/prog_guide/meson_ut.rst | 12 +-
doc/guides/prog_guide/metrics_lib.rst | 26 ++--
doc/guides/prog_guide/mldev.rst | 20 +--
doc/guides/prog_guide/multi_proc_support.rst | 28 ++--
doc/guides/prog_guide/overview.rst | 10 +-
.../prog_guide/packet_classif_access_ctrl.rst | 10 +-
doc/guides/prog_guide/packet_distrib_lib.rst | 6 +-
doc/guides/prog_guide/packet_framework.rst | 6 +-
doc/guides/prog_guide/pdcp_lib.rst | 24 +--
doc/guides/prog_guide/pdump_lib.rst | 6 +-
doc/guides/prog_guide/power_man.rst | 8 +-
doc/guides/prog_guide/profile_app.rst | 2 +-
doc/guides/prog_guide/rcu_lib.rst | 143 +++++++++++-------
doc/guides/prog_guide/regexdev.rst | 24 +--
doc/guides/prog_guide/reorder_lib.rst | 4 +-
doc/guides/prog_guide/rib_lib.rst | 2 +-
doc/guides/prog_guide/ring_lib.rst | 2 +-
doc/guides/prog_guide/rte_security.rst | 4 +-
doc/guides/prog_guide/service_cores.rst | 30 ++--
doc/guides/prog_guide/stack_lib.rst | 32 ++--
doc/guides/prog_guide/thread_safety.rst | 2 +-
doc/guides/prog_guide/toeplitz_hash_lib.rst | 4 +-
doc/guides/prog_guide/trace_lib.rst | 118 +++++++--------
doc/guides/prog_guide/vhost_lib.rst | 22 +--
.../prog_guide/writing_efficient_code.rst | 2 +-
53 files changed, 488 insertions(+), 418 deletions(-)
--
2.51.0
next prev parent reply other threads:[~2026-01-18 19:13 UTC|newest]
Thread overview: 118+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-13 15:59 [PATCH 0/9] reowrd in prog guide Nandini Persad
2024-05-13 15:59 ` [PATCH 1/9] doc: reword design section in contributors guidelines Nandini Persad
2024-05-13 15:59 ` [PATCH 2/9] doc: reword pmd section in prog guide Nandini Persad
2024-05-13 15:59 ` [PATCH 3/9] doc: reword argparse " Nandini Persad
2024-05-13 19:01 ` Stephen Hemminger
2024-05-13 15:59 ` [PATCH 4/9] doc: reword service cores " Nandini Persad
2024-05-13 15:59 ` [PATCH 5/9] doc: reword trace library " Nandini Persad
2024-05-13 15:59 ` [PATCH 6/9] doc: reword log " Nandini Persad
2024-05-13 15:59 ` [PATCH 7/9] doc: reword cmdline " Nandini Persad
2024-05-13 15:59 ` [PATCH 8/9] doc: reword stack library " Nandini Persad
2024-05-13 15:59 ` [PATCH 9/9] doc: reword rcu " Nandini Persad
2024-06-21 2:32 ` [PATCH v2 1/9] doc: reword pmd " Nandini Persad
2024-06-21 2:32 ` [PATCH v2 2/9] doc: reword argparse " Nandini Persad
2024-06-22 14:53 ` Stephen Hemminger
2026-03-30 16:08 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 3/9] doc: reword design section in contributors guidelines Nandini Persad
2024-06-22 14:47 ` [PATCH] doc/design: minor cleanus Stephen Hemminger
2024-06-24 15:07 ` Thomas Monjalon
2026-03-31 22:53 ` [PATCH v2 3/9] doc: reword design section in contributors guidelines Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 4/9] doc: reword service cores section in prog guide Nandini Persad
2024-06-22 14:53 ` Stephen Hemminger
2026-03-31 22:50 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 5/9] doc: reword trace library " Nandini Persad
2024-06-22 14:54 ` Stephen Hemminger
2026-03-31 22:49 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 6/9] doc: reword log " Nandini Persad
2024-06-22 14:55 ` Stephen Hemminger
2026-03-31 22:47 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 7/9] doc: reword cmdline " Nandini Persad
2024-06-22 14:55 ` Stephen Hemminger
2026-03-31 22:45 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 8/9] doc: reword stack library " Nandini Persad
2024-06-22 14:55 ` Stephen Hemminger
2026-03-31 22:36 ` Stephen Hemminger
2024-06-21 2:32 ` [PATCH v2 9/9] doc: reword rcu " Nandini Persad
2024-06-22 14:55 ` Stephen Hemminger
2026-03-31 22:35 ` Stephen Hemminger
2024-06-22 14:52 ` [PATCH v2 1/9] doc: reword pmd " Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 00/11] doc: programmers guide corrections Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 01/11] doc: correct grammar and punctuation errors in ethdev guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 02/11] doc: correct grammar and typos in argparse library guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 03/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 04/11] doc: correct errors in Linux system requirements guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 05/11] doc: correct grammar in service cores guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 06/11] doc: correct grammar and errors in trace library guide Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 07/11] doc: correct typos in log " Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 08/11] doc: correct errors in command-line " Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 09/11] doc: correct errors in trace " Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 10/11] doc: correct errors in stack " Stephen Hemminger
2026-01-13 22:51 ` [PATCH v3 11/11] doc: correct errors in RCU " Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 00/11] doc: programmers guide corrections Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 01/11] doc: correct grammar and punctuation errors in ethdev guide Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 02/11] doc: correct grammar and typos in argparse library guide Stephen Hemminger
2026-01-19 0:50 ` fengchengwen
2026-01-14 22:26 ` [PATCH v4 03/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 04/11] doc: correct errors in Linux system requirements guide Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 05/11] doc: correct grammar in service cores guide Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 06/11] doc: correct grammar and errors in trace library guide Stephen Hemminger
2026-01-14 22:26 ` [PATCH v4 07/11] doc: correct typos in log " Stephen Hemminger
2026-01-14 22:27 ` [PATCH v4 08/11] doc: correct errors in command-line " Stephen Hemminger
2026-01-14 22:27 ` [PATCH v4 09/11] doc: correct errors in trace " Stephen Hemminger
2026-01-14 22:27 ` [PATCH v4 10/11] doc: correct errors in stack " Stephen Hemminger
2026-01-14 22:27 ` [PATCH v4 11/11] doc: correct errors in RCU " Stephen Hemminger
2026-01-18 19:10 ` Stephen Hemminger [this message]
2026-01-18 19:10 ` [PATCH v5 01/54] doc: correct grammar and typos in argparse " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 02/54] doc: correct grammar in service cores guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 03/54] doc: correct grammar and errors in trace library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 04/54] doc: correct typos in log " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 05/54] doc: correct errors in command-line " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 06/54] doc: correct errors in trace " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 07/54] doc: correct errors in stack " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 08/54] doc: correct errors in RCU " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 09/54] doc: correct grammar and formatting in ASan guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 10/54] doc: correct grammar and typos in bbdev guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 11/54] doc: correct grammar and formatting in bpf lib guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 12/54] doc: correct grammar and typos in meson build guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 13/54] doc: correct grammar and typos in cryptodev guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 14/54] doc: correct grammar and formatting in compressdev guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 15/54] doc: correct grammar in dmadev guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 16/54] doc: correct grammar in efd guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 17/54] doc: correct grammar in EAL guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 18/54] doc: correct double space in FIB guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 19/54] doc: correct grammar in GRO guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 20/54] doc: correct grammar in GSO guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 21/54] doc: correct typos and grammar in graph guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 22/54] doc: correct grammar in hash guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 23/54] doc: correct grammar and typos in IP fragment guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 24/54] doc: correct double spaces in IPsec guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 25/54] doc: correct grammar in lcore variables guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 26/54] doc: correct typo in link bonding guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 27/54] doc: correct grammar in LTO guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 28/54] doc: correct grammar in LPM guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 29/54] doc: correct grammar and typo in LPM6 guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 30/54] doc: correct grammar in introduction Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 31/54] doc: correct grammar in mbuf library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 32/54] doc: correct grammar in membership " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 33/54] doc: correct errors in mempool " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 34/54] doc: correct style in meson unit tests guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 35/54] doc: correct errors in metrics library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 36/54] doc: correct grammar in mldev " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 37/54] doc: correct grammar in multi-process guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 38/54] doc: correct grammar in overview Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 39/54] doc: correct grammar in ACL library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 40/54] doc: correct typos in packet distributor guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 41/54] doc: correct grammar in packet framework guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 42/54] doc: correct grammar in PDCP library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 43/54] doc: correct grammar in pdump " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 44/54] doc: correct typos in power management guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 45/54] doc: correct grammar in profiling guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 46/54] doc: correct errors in regexdev guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 47/54] doc: correct grammar in reorder library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 48/54] doc: correct whitespace in RIB " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 49/54] doc: correct incomplete sentence in ring " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 50/54] doc: correct grammar in security " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 51/54] doc: correct hyphenation in thread safety guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 52/54] doc: correct errors in toeplitz hash library guide Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 53/54] doc: correct errors in vhost " Stephen Hemminger
2026-01-18 19:10 ` [PATCH v5 54/54] doc: correct whitespace in efficient code guide 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=20260118191323.241013-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