Skip to content

doc: ethdev documentation grammar and typo corrections

Stephen Hemminger dpdk-dev 2 versions – Applied

Status from this message: Queued this to next-net.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest8 patches 3 repliesApplied
  2. v15 patches 0 repliesSuperseded

Changes in v2 from the cover letter

- Add patch to fix minor grammar issue in ethdev introduction
- Add patch to correct alphabetical ordering in ethdev toctree
- Add patch to fix grammar issues in traffic metering and policing guide

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/8doc: correct grammar and punctuation errors in ethdev guidedoc/guides/prog_guide/ethdev/ethdev.rst+277 -2800 replies
2/8doc: correct grammar in flow guidedoc/guides/prog_guide/ethdev/flow_offload.rst+30 -280 replies
3/8doc: correct grammar in QoS framework guidedoc/guides/prog_guide/ethdev/qos_framework.rst+30 -290 replies
4/8doc: correct typos in switch representation guidedoc/guides/prog_guide/ethdev/switch_representation.rst+3 -30 replies
5/8doc: correct typos in traffic management guidedoc/guides/prog_guide/ethdev/traffic_management.rst+12 -130 replies
6/8doc: correct grammar and improve clarity in ethdev guidedoc/guides/prog_guide/ethdev/ethdev.rst+1 -11 reply
7/8doc: correct alphabetical ordering in ethdev toctreedoc/guides/prog_guide/ethdev/index.rst+3 -31 reply
8/8doc: correct grammar and improve clarity in MTR guidedoc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst+5 -30 replies

Reviews trailers per patch

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

Read the v2 thread

Cover letter [PATCH v2 0/8] doc: ethdev documentation grammar and typo corrections

This series corrects grammar errors, typos, and punctuation issues in the Ethernet device library section of the DPDK Programmer's Guide. Initial work on this was done as part of review by technical writer then more changes as result of AI reviews.

The first patch provides a comprehensive update to the Poll Mode Driver documentation, modernizing the description and improving readability. The remaining patches address smaller issues in the rte_flow, QoS framework, switch representation, traffic management, and traffic metering guides.

v2:
- Add patch to fix minor grammar issue in ethdev introduction
- Add patch to correct alphabetical ordering in ethdev toctree
- Add patch to fix grammar issues in traffic metering and policing guide

Stephen Hemminger (8):
doc: correct grammar and punctuation errors in ethdev guide
doc: correct grammar in flow guide
doc: correct grammar in QoS framework guide
doc: correct typos in switch representation guide
doc: correct typos in traffic management guide
doc: correct grammar and improve clarity in ethdev guide
doc: correct alphabetical ordering in ethdev toctree
doc: correct grammar and improve clarity in MTR guide

 doc/guides/prog_guide/ethdev/ethdev.rst       | 557 +++++++++---------
 doc/guides/prog_guide/ethdev/flow_offload.rst |  58 +-
 doc/guides/prog_guide/ethdev/index.rst        |   6 +-
 .../prog_guide/ethdev/qos_framework.rst       |  59 +-
 .../ethdev/switch_representation.rst          |   6 +-
 .../prog_guide/ethdev/traffic_management.rst  |  25 +-
 .../ethdev/traffic_metering_and_policing.rst  |   8 +-
 7 files changed, 360 insertions(+), 359 deletions(-)
Signature · 1 line
2.51.0