doc: Linux Getting Started Guide grammar and clarity improvements
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest11 patches 2 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/11 | doc: correct errors in Linux system requirements guidedoc/ | +7 | 0 replies | |
| 2/11 | doc: correct grammar in AMD platform guidedoc/ | +3 | 1 reply | |
| 3/11 | doc: correct typos in DPDK build guidedoc/ | +2 | 0 replies | |
| 4/11 | doc: correct grammar in sample applications guidedoc/ | +4 | 0 replies | |
| 5/11 | doc: correct grammar in Intel platform guidedoc/ | +4 | 0 replies | |
| 6/11 | doc: correct word choice and redundant text in introdoc/ | +2 | 0 replies | |
| 7/11 | doc: correct grammar in ARM64 cross-compile guidedoc/ | +4 | 0 replies | |
| 8/11 | doc: remove redundant text in documentation roadmapdoc/ | +1 | 0 replies | |
| 9/11 | doc: correct grammar and formatting in EAL argumentsdoc/ | +8 | 0 replies | |
| 10/11 | doc: correct typos in enabling functionality guidedoc/ | +3 | 0 replies | |
| 11/11 | doc: correct grammar in Linux drivers guidedoc/ | +5 | 0 replies |
Reviews trailers per patch
1 of 11 patches has a Reviewed-by or Acked-by.
| Patch | Vipin Varghese |
|---|---|
| 1/11 | |
| 2/11 | A-b |
| 3/11 | |
| 4/11 | |
| 5/11 | |
| 6/11 | |
| 7/11 | |
| 8/11 | |
| 9/11 | |
| 10/11 | |
| 11/11 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH 00/11] doc: Linux Getting Started Guide grammar and clarity improvements
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(-)
Signature · 1 line
2.51.0