Skip to content

doc: programmers guide corrections

Stephen Hemminger dpdk-dev 3 versions – Applied

Status from this message: Applied, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest54 patches 1 replyApplied
  2. v411 patches 1 replySuperseded
  3. v311 patches 0 repliesSuperseded

Patches in v5 Applied

#Subject and filesSizeRepliesApplied
1/54doc: correct grammar and typos in argparse library guidedoc/guides/prog_guide/argparse_lib.rst+12 -120 replies
2/54doc: correct grammar in service cores guidedoc/guides/prog_guide/service_cores.rst+15 -150 replies
3/54doc: correct grammar and errors in trace library guidedoc/guides/prog_guide/trace_lib.rst+34 -340 replies
4/54doc: correct typos in log library guidedoc/guides/prog_guide/log_lib.rst+16 -160 replies
5/54doc: correct errors in command-line library guidedoc/guides/prog_guide/cmdline.rst+21 -210 replies
6/54doc: correct errors in trace library guidedoc/guides/prog_guide/trace_lib.rst+40 -400 replies
7/54doc: correct errors in stack library guidedoc/guides/prog_guide/stack_lib.rst+16 -160 replies
8/54doc: correct errors in RCU library guidedoc/guides/prog_guide/rcu_lib.rst+86 -570 replies
9/54doc: correct grammar and formatting in ASan guidedoc/guides/prog_guide/asan.rst+9 -50 replies
10/54doc: correct grammar and typos in bbdev guidedoc/guides/prog_guide/bbdev.rst+3 -30 replies
11/54doc: correct grammar and formatting in bpf lib guidedoc/guides/prog_guide/bpf_lib.rst+40 -60 replies
12/54doc: correct grammar and typos in meson build guidedoc/guides/prog_guide/build-sdk-meson.rst+5 -50 replies
13/54doc: correct grammar and typos in cryptodev guidedoc/guides/prog_guide/cryptodev_lib.rst+11 -100 replies
14/54doc: correct grammar and formatting in compressdev guidedoc/guides/prog_guide/compressdev.rst+5 -50 replies
15/54doc: correct grammar in dmadev guidedoc/guides/prog_guide/dmadev.rst+3 -30 replies
16/54doc: correct grammar in efd guidedoc/guides/prog_guide/efd_lib.rst+4 -40 replies
17/54doc: correct grammar in EAL guidedoc/guides/prog_guide/env_abstraction_layer.rst+2 -20 replies
18/54doc: correct double space in FIB guidedoc/guides/prog_guide/fib_lib.rst+1 -10 replies
19/54doc: correct grammar in GRO guidedoc/guides/prog_guide/generic_receive_offload_lib.rst+10 -100 replies
20/54doc: correct grammar in GSO guidedoc/guides/prog_guide/generic_segmentation_offload_lib.rst+1 -10 replies
21/54doc: correct typos and grammar in graph guidedoc/guides/prog_guide/graph_lib.rst+8 -80 replies
22/54doc: correct grammar in hash guidedoc/guides/prog_guide/hash_lib.rst+2 -20 replies
23/54doc: correct grammar and typos in IP fragment guidedoc/guides/prog_guide/ip_fragment_reassembly_lib.rst+6 -60 replies
24/54doc: correct double spaces in IPsec guidedoc/guides/prog_guide/ipsec_lib.rst+2 -20 replies
25/54doc: correct grammar in lcore variables guidedoc/guides/prog_guide/lcore_var.rst+1 -10 replies
26/54doc: correct typo in link bonding guidedoc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst+1 -10 replies
27/54doc: correct grammar in LTO guidedoc/guides/prog_guide/lto.rst+1 -10 replies
28/54doc: correct grammar in LPM guidedoc/guides/prog_guide/lpm_lib.rst+1 -10 replies
29/54doc: correct grammar and typo in LPM6 guidedoc/guides/prog_guide/lpm6_lib.rst+2 -20 replies
30/54doc: correct grammar in introductiondoc/guides/prog_guide/intro.rst+2 -20 replies
31/54doc: correct grammar in mbuf library guidedoc/guides/prog_guide/mbuf_lib.rst+14 -120 replies
32/54doc: correct grammar in membership library guidedoc/guides/prog_guide/member_lib.rst+13 -130 replies
33/54doc: correct errors in mempool library guidedoc/guides/prog_guide/mempool_lib.rst+4 -40 replies
34/54doc: correct style in meson unit tests guidedoc/guides/prog_guide/meson_ut.rst+6 -60 replies
35/54doc: correct errors in metrics library guidedoc/guides/prog_guide/metrics_lib.rst+13 -130 replies
36/54doc: correct grammar in mldev library guidedoc/guides/prog_guide/mldev.rst+10 -100 replies
37/54doc: correct grammar in multi-process guidedoc/guides/prog_guide/multi_proc_support.rst+14 -140 replies
38/54doc: correct grammar in overviewdoc/guides/prog_guide/overview.rst+5 -50 replies
39/54doc: correct grammar in ACL library guidedoc/guides/prog_guide/packet_classif_access_ctrl.rst+5 -50 replies
40/54doc: correct typos in packet distributor guidedoc/guides/prog_guide/packet_distrib_lib.rst+3 -30 replies
41/54doc: correct grammar in packet framework guidedoc/guides/prog_guide/packet_framework.rst+3 -30 replies
42/54doc: correct grammar in PDCP library guidedoc/guides/prog_guide/pdcp_lib.rst+12 -120 replies
43/54doc: correct grammar in pdump library guidedoc/guides/prog_guide/pdump_lib.rst+3 -30 replies
44/54doc: correct typos in power management guidedoc/guides/prog_guide/power_man.rst+4 -40 replies
45/54doc: correct grammar in profiling guidedoc/guides/prog_guide/profile_app.rst+1 -10 replies
46/54doc: correct errors in regexdev guidedoc/guides/prog_guide/regexdev.rst+12 -120 replies
47/54doc: correct grammar in reorder library guidedoc/guides/prog_guide/reorder_lib.rst+2 -20 replies
48/54doc: correct whitespace in RIB library guidedoc/guides/prog_guide/rib_lib.rst+1 -10 replies
49/54doc: correct incomplete sentence in ring library guidedoc/guides/prog_guide/ring_lib.rst+1 -10 replies
50/54doc: correct grammar in security library guidedoc/guides/prog_guide/rte_security.rst+2 -20 replies
51/54doc: correct hyphenation in thread safety guidedoc/guides/prog_guide/thread_safety.rst+1 -10 replies
52/54doc: correct errors in toeplitz hash library guidedoc/guides/prog_guide/toeplitz_hash_lib.rst+2 -20 replies
53/54doc: correct errors in vhost library guidedoc/guides/prog_guide/vhost_lib.rst+11 -110 replies
54/54doc: correct whitespace in efficient code guidedoc/guides/prog_guide/writing_efficient_code.rst+1 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.

Read the v5 thread

Cover letter [PATCH v5 00/54] doc: programmers guide corrections

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(-)
Signature · 1 line
2.51.0