[PATCH 00/11] doc: Linux Getting Started Guide grammar and clarity improvements

Stephen Hemminger
2026-01-16T21:16:57Z

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