doc: programmers guide corrections
Status from this message: Applied, thanks.
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v5 Latest54 patches 1 replyApplied
- v411 patches 1 replySuperseded
- v311 patches 0 repliesSuperseded
Patches in v5 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/54 | doc: correct grammar and typos in argparse library guidedoc/ | +12 | 0 replies | |
| 2/54 | doc: correct grammar in service cores guidedoc/ | +15 | 0 replies | |
| 3/54 | doc: correct grammar and errors in trace library guidedoc/ | +34 | 0 replies | |
| 4/54 | doc: correct typos in log library guidedoc/ | +16 | 0 replies | |
| 5/54 | doc: correct errors in command-line library guidedoc/ | +21 | 0 replies | |
| 6/54 | doc: correct errors in trace library guidedoc/ | +40 | 0 replies | |
| 7/54 | doc: correct errors in stack library guidedoc/ | +16 | 0 replies | |
| 8/54 | doc: correct errors in RCU library guidedoc/ | +86 | 0 replies | |
| 9/54 | doc: correct grammar and formatting in ASan guidedoc/ | +9 | 0 replies | |
| 10/54 | doc: correct grammar and typos in bbdev guidedoc/ | +3 | 0 replies | |
| 11/54 | doc: correct grammar and formatting in bpf lib guidedoc/ | +40 | 0 replies | |
| 12/54 | doc: correct grammar and typos in meson build guidedoc/ | +5 | 0 replies | |
| 13/54 | doc: correct grammar and typos in cryptodev guidedoc/ | +11 | 0 replies | |
| 14/54 | doc: correct grammar and formatting in compressdev guidedoc/ | +5 | 0 replies | |
| 15/54 | doc: correct grammar in dmadev guidedoc/ | +3 | 0 replies | |
| 16/54 | doc: correct grammar in efd guidedoc/ | +4 | 0 replies | |
| 17/54 | doc: correct grammar in EAL guidedoc/ | +2 | 0 replies | |
| 18/54 | doc: correct double space in FIB guidedoc/ | +1 | 0 replies | |
| 19/54 | doc: correct grammar in GRO guidedoc/ | +10 | 0 replies | |
| 20/54 | doc: correct grammar in GSO guidedoc/ | +1 | 0 replies | |
| 21/54 | doc: correct typos and grammar in graph guidedoc/ | +8 | 0 replies | |
| 22/54 | doc: correct grammar in hash guidedoc/ | +2 | 0 replies | |
| 23/54 | doc: correct grammar and typos in IP fragment guidedoc/ | +6 | 0 replies | |
| 24/54 | doc: correct double spaces in IPsec guidedoc/ | +2 | 0 replies | |
| 25/54 | doc: correct grammar in lcore variables guidedoc/ | +1 | 0 replies | |
| 26/54 | doc: correct typo in link bonding guidedoc/ | +1 | 0 replies | |
| 27/54 | doc: correct grammar in LTO guidedoc/ | +1 | 0 replies | |
| 28/54 | doc: correct grammar in LPM guidedoc/ | +1 | 0 replies | |
| 29/54 | doc: correct grammar and typo in LPM6 guidedoc/ | +2 | 0 replies | |
| 30/54 | doc: correct grammar in introductiondoc/ | +2 | 0 replies | |
| 31/54 | doc: correct grammar in mbuf library guidedoc/ | +14 | 0 replies | |
| 32/54 | doc: correct grammar in membership library guidedoc/ | +13 | 0 replies | |
| 33/54 | doc: correct errors in mempool library guidedoc/ | +4 | 0 replies | |
| 34/54 | doc: correct style in meson unit tests guidedoc/ | +6 | 0 replies | |
| 35/54 | doc: correct errors in metrics library guidedoc/ | +13 | 0 replies | |
| 36/54 | doc: correct grammar in mldev library guidedoc/ | +10 | 0 replies | |
| 37/54 | doc: correct grammar in multi-process guidedoc/ | +14 | 0 replies | |
| 38/54 | doc: correct grammar in overviewdoc/ | +5 | 0 replies | |
| 39/54 | doc: correct grammar in ACL library guidedoc/ | +5 | 0 replies | |
| 40/54 | doc: correct typos in packet distributor guidedoc/ | +3 | 0 replies | |
| 41/54 | doc: correct grammar in packet framework guidedoc/ | +3 | 0 replies | |
| 42/54 | doc: correct grammar in PDCP library guidedoc/ | +12 | 0 replies | |
| 43/54 | doc: correct grammar in pdump library guidedoc/ | +3 | 0 replies | |
| 44/54 | doc: correct typos in power management guidedoc/ | +4 | 0 replies | |
| 45/54 | doc: correct grammar in profiling guidedoc/ | +1 | 0 replies | |
| 46/54 | doc: correct errors in regexdev guidedoc/ | +12 | 0 replies | |
| 47/54 | doc: correct grammar in reorder library guidedoc/ | +2 | 0 replies | |
| 48/54 | doc: correct whitespace in RIB library guidedoc/ | +1 | 0 replies | |
| 49/54 | doc: correct incomplete sentence in ring library guidedoc/ | +1 | 0 replies | |
| 50/54 | doc: correct grammar in security library guidedoc/ | +2 | 0 replies | |
| 51/54 | doc: correct hyphenation in thread safety guidedoc/ | +1 | 0 replies | |
| 52/54 | doc: correct errors in toeplitz hash library guidedoc/ | +2 | 0 replies | |
| 53/54 | doc: correct errors in vhost library guidedoc/ | +11 | 0 replies | |
| 54/54 | doc: correct whitespace in efficient code guidedoc/ | +1 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.
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