public inbox for dev@dpdk.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 00/11] doc: Linux Getting Started Guide grammar and clarity improvements
Date: Fri, 16 Jan 2026 13:06:16 -0800	[thread overview]
Message-ID: <20260116211649.104776-1-stephen@networkplumber.org> (raw)

This series improves the Linux Getting Started Guide documentation by
using AI to correct grammar errors, typos, and improving clarity throughout.
Split into multiple patches for easier review.

The changes include:
- Subject-verb agreement corrections
- Missing articles and prepositions
- Typo corrections (e.g., "by be" -> "may be", "my" -> "may")
- Consistent terminology (e.g., "toolchain" vs "tool chain")
- Proper punctuation (missing colons, possessive apostrophes)
- Formatting consistency (RST directive case, bullet spacing)
- Word choice improvements ("customers" -> "users")
- Technical corrections (hugetlbfs mount syntax)

Files modified:
- sys_reqs.rst: capitalization, spacing, mount command syntax
- amd_platform.rst: missing prepositions, colons
- build_dpdk.rst: typo, capitalization
- build_sample_apps.rst: grammar, hexadecimal notation
- nic_perf_intel_platform.rst: subject-verb agreement
- intro.rst: word choice, redundant text
- cross_build_dpdk_for_arm64.rst: grammar, spelling consistency
- doc_roadmap.include.rst: redundant text
- eal_args.include.rst: grammar, RST formatting
- enable_func.rst: typos, hyphenation
- linux_drivers.rst: grammar, cross-reference direction

Stephen Hemminger (11):
  doc: correct errors in Linux system requirements guide
  doc: correct grammar in AMD platform guide
  doc: correct typos in DPDK build guide
  doc: correct grammar in sample applications guide
  doc: correct grammar in Intel platform guide
  doc: correct word choice and redundant text in intro
  doc: correct grammar in ARM64 cross-compile guide
  doc: remove redundant text in documentation roadmap
  doc: correct grammar and formatting in EAL arguments
  doc: correct typos in enabling functionality guide
  doc: correct grammar in Linux drivers guide

 doc/guides/linux_gsg/amd_platform.rst            |  6 +++---
 doc/guides/linux_gsg/build_dpdk.rst              |  4 ++--
 doc/guides/linux_gsg/build_sample_apps.rst       |  8 ++++----
 .../linux_gsg/cross_build_dpdk_for_arm64.rst     |  8 ++++----
 doc/guides/linux_gsg/doc_roadmap.include.rst     |  2 +-
 doc/guides/linux_gsg/eal_args.include.rst        | 16 ++++++++--------
 doc/guides/linux_gsg/enable_func.rst             |  6 +++---
 doc/guides/linux_gsg/intro.rst                   |  4 ++--
 doc/guides/linux_gsg/linux_drivers.rst           | 10 +++++-----
 doc/guides/linux_gsg/nic_perf_intel_platform.rst |  8 ++++----
 doc/guides/linux_gsg/sys_reqs.rst                | 14 +++++++-------
 11 files changed, 43 insertions(+), 43 deletions(-)

-- 
2.51.0


             reply	other threads:[~2026-01-16 21:16 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-16 21:06 Stephen Hemminger [this message]
2026-01-16 21:06 ` [PATCH 01/11] doc: correct errors in Linux system requirements guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 02/11] doc: correct grammar in AMD platform guide Stephen Hemminger
2026-01-20  9:33   ` Varghese, Vipin
2026-01-16 21:06 ` [PATCH 03/11] doc: correct typos in DPDK build guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 04/11] doc: correct grammar in sample applications guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 05/11] doc: correct grammar in Intel platform guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 06/11] doc: correct word choice and redundant text in intro Stephen Hemminger
2026-01-16 21:06 ` [PATCH 07/11] doc: correct grammar in ARM64 cross-compile guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 08/11] doc: remove redundant text in documentation roadmap Stephen Hemminger
2026-01-16 21:06 ` [PATCH 09/11] doc: correct grammar and formatting in EAL arguments Stephen Hemminger
2026-01-16 21:06 ` [PATCH 10/11] doc: correct typos in enabling functionality guide Stephen Hemminger
2026-01-16 21:06 ` [PATCH 11/11] doc: correct grammar in Linux drivers guide Stephen Hemminger
2026-03-31 17:31 ` [PATCH 00/11] doc: Linux Getting Started Guide grammar and clarity improvements Thomas Monjalon

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=20260116211649.104776-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