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

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

[Stephen Hemminger]

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

[PATCH 01/11] doc: correct errors in Linux system requirements guide

[Stephen Hemminger]

Changes:
- Fix capitalization of IBM Advance Toolchain
- Remove double spaces before "support"
- Add missing preposition "in" and article "the"
- Fix hugetlbfs mount command syntax (add -o flag and device)

Signed-off-by: Nandini Persad <nandinipersad361@gmail.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/sys_reqs.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index 52a840fbe9..869584c344 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -68,7 +68,7 @@ Compilation of the DPDK
 
 *   Intel\ |reg| oneAPI DPC++/C++ Compiler.
 
-*   IBM\ |reg| Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries
+*   IBM\ |reg| Advance Toolchain for Powerlinux. This is a set of open source development tools and runtime libraries
     which allows users to take leading edge advantage of IBM's latest POWER hardware features on Linux. To install
     it, see the IBM official installation document.
 
@@ -93,7 +93,7 @@ e.g. :doc:`../nics/index`
 Running DPDK Applications
 -------------------------
 
-To run a DPDK application, some customization may be required on the target machine.
+To run a DPDK application, customization may be required on the target machine.
 
 System Software
 ~~~~~~~~~~~~~~~
@@ -127,9 +127,9 @@ System Software
 
     *   HUGETLBFS
 
-    *   PROC_PAGE_MONITOR  support
+    *   PROC_PAGE_MONITOR support
 
-    *   HPET and HPET_MMAP configuration options should also be enabled if HPET  support is required.
+    *   HPET and HPET_MMAP configuration options should also be enabled if HPET support is required.
         See the section on :ref:`High Precision Event Timer (HPET) Functionality <High_Precision_Event_Timer>` for more details.
 
 .. _linux_gsg_hugepages:
@@ -138,7 +138,7 @@ Use of Hugepages in the Linux Environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Hugepage support is required for the large memory pool allocation used for packet buffers
-(the HUGETLBFS option must be enabled in the running kernel as indicated the previous section).
+(the HUGETLBFS option must be enabled in the running kernel as indicated in the previous section).
 By using hugepage allocations, performance is increased since fewer pages are needed,
 and therefore less Translation Lookaside Buffers (TLBs, high speed translation caches),
 which reduce the time it takes to translate a virtual page address to a physical page address.
@@ -225,10 +225,10 @@ However, in order to use hugepage sizes other than the default, it is necessary
 to manually create mount points for those hugepage sizes (e.g. 1GB pages).
 
 To make the hugepages of size 1GB available for DPDK use,
-following steps must be performed::
+the following steps must be performed::
 
     mkdir /mnt/huge
-    mount -t hugetlbfs pagesize=1GB /mnt/huge
+    mount -t hugetlbfs -o pagesize=1GB none /mnt/huge
 
 The mount point can be made permanent across reboots, by adding the following line to the ``/etc/fstab`` file::
 
-- 
2.51.0

[PATCH 02/11] doc: correct grammar in AMD platform guide

[Stephen Hemminger]

Add missing "to" in "refer to the tuning guides"
Add missing article "the" before "DPDK power management"
Add missing colons after introductory sentences

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/amd_platform.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/linux_gsg/amd_platform.rst b/doc/guides/linux_gsg/amd_platform.rst
index 40b65d1c9e..40d8d93cad 100644
--- a/doc/guides/linux_gsg/amd_platform.rst
+++ b/doc/guides/linux_gsg/amd_platform.rst
@@ -101,13 +101,13 @@ Uncore
 
 AMD EPYC SoC support UNCORE power functions via ``rte_power_uncore`` from `25.03` onwards.
 These are tested and validated on GENOA, SIENA and TURIN.
-Please refer the tuning guides to enable ``HSMP`` and DPDK power management guide.
+Please refer to the tuning guides to enable ``HSMP`` and the DPDK power management guide.
 
 
 NIC
 ---
 
-To use Solarflare x4 on AMD EPYC TURIN, please ensure the following
+To use Solarflare x4 on AMD EPYC TURIN, please ensure the following:
 
 #. Upgrade Linux or distro version to 6.13 or higher.
 
@@ -118,7 +118,7 @@ To use Solarflare x4 on AMD EPYC TURIN, please ensure the following
 
 #. Please use PMD args ``fw_variant=ultra-low-latency,perf_profile=throughput``.
 
-To use Solarflare x2 on AMD EPYC TURIN, please ensure the following
+To use Solarflare x2 on AMD EPYC TURIN, please ensure the following:
 
 #. Upgrade Linux or distro version to 6.13 or higher.
 
-- 
2.51.0

RE: [PATCH 02/11] doc: correct grammar in AMD platform guide

[Varghese, Vipin]

[Public]

Acked-by: Vipin Varghese <vipin.varghese@amd.com>

[PATCH 03/11] doc: correct typos in DPDK build guide

[Stephen Hemminger]

Fix "a set a" to "a set of" configuration parameters.
Capitalize sentence-initial "an" to "An".

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/build_dpdk.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 2a983412dd..ed30e4a5f1 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -100,7 +100,7 @@ to a regular "debug" build, you can either:
 * run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run.
 
 Other options are specific to the DPDK project but can be adjusted similarly.
-The "platform" option specifies a set a configuration parameters that will be used.
+The "platform" option specifies a set of configuration parameters that will be used.
 The valid values are:
 
 * ``-Dplatform=native`` will tailor the configuration to the build machine.
@@ -327,7 +327,7 @@ and the sources for that build are stored in ``$(SRCS-y)``.
    location in the user's home directory. The install location can be set
    using the `--prefix` meson option (default: `/usr/local`).
 
-an equivalent build recipe for a simple DPDK application using meson as a
+An equivalent build recipe for a simple DPDK application using meson as a
 build system is shown below:
 
 .. code-block:: python
-- 
2.51.0

[PATCH 04/11] doc: correct grammar in sample applications guide

[Stephen Hemminger]

Change "detail" to "details" for plural form.
Capitalize sentence-initial "refer" to "Refer".
Change "by be" to "may be" (typo).
Clarify coredump_filter default value notation as "0x33".

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/build_sample_apps.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index cae17f0e33..5195af67ad 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -10,7 +10,7 @@ It also provides a pointer to where sample applications are stored.
 Compiling a Sample Application
 ------------------------------
 
-Please refer to :ref:`building_app_using_installed_dpdk` for detail on compiling sample apps.
+Please refer to :ref:`building_app_using_installed_dpdk` for details on compiling sample apps.
 
 Running a Sample Application
 ----------------------------
@@ -24,7 +24,7 @@ Running a Sample Application
     - In case needed, ports being used by the application should be
       bound to the corresponding kernel driver.
 
-    refer to :ref:`linux_gsg_linux_drivers` for more details.
+    Refer to :ref:`linux_gsg_linux_drivers` for more details.
 
 The application is linked with the DPDK target environment's Environmental Abstraction Layer (EAL) library,
 which provides some options that are generic to every DPDK application.
@@ -85,7 +85,7 @@ The reason is as follows.
 Suppose the system has 1024 reserved 2 MB pages in socket 0 and 1024 in socket 1.
 If the user requests 128 MB of memory, the 64 pages may not match the constraints:
 
-*   The hugepage memory by be given to the application by the kernel in socket 1 only.
+*   The hugepage memory may be given to the application by the kernel in socket 1 only.
     In this case, if the application attempts to create an object, such as a ring or memory pool in socket 0, it fails.
     To avoid this issue, it is recommended that the ``--numa-mem`` option be used instead of the ``-m`` option.
 
@@ -100,7 +100,7 @@ No memory will be reserved on any CPU socket that is not explicitly referenced,
 If the DPDK cannot allocate enough memory on each socket, the EAL initialization fails.
 
 Whether hugepages are included in core dump is controlled by ``/proc/<pid>/coredump_filter``.
-It is ``33`` (hexadecimal) by default, which means that hugepages are excluded from core dump.
+The default value is ``0x33``, which means that hugepages are excluded from core dump.
 This setting is per-process and is inherited.
 Refer to ``core(5)`` for details.
 To include mapped hugepages in core dump, set bit 6 (``0x40``) in the parent process
-- 
2.51.0

[PATCH 05/11] doc: correct grammar in Intel platform guide

[Stephen Hemminger]

Change "take" to "taken" in passive construction.
Change "you wants" to "you want".
Rephrase awkward "If it wants" construction.
Change "drivers needs" to "drivers need" for subject-verb agreement.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/nic_perf_intel_platform.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
index 4a5815dfb9..601d7bdc7a 100644
--- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
+++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
@@ -82,7 +82,7 @@ You can use ``lspci`` to check the speed of a PCI slot using something like the
 
 When inserting NICs into PCI slots always check the caption, such as CPU0 or CPU1 to indicate which socket it is connected to.
 
-Care should be take with NUMA.
+Care should be taken with NUMA.
 If you are using 2 or more ports from different NICs, it is best to ensure that these NICs are on the same CPU socket.
 An example of how to determine this is shown further below.
 
@@ -101,7 +101,7 @@ so the following is mainly for reference:
 
 #. Consider using Turbo Boost to increase the frequency on cores.
 
-#. Disable all virtualization options when you test the physical function of the NIC, and turn on VT-d if you wants to use VFIO.
+#. Disable all virtualization options when you test the physical function of the NIC, and turn on VT-d if you want to use VFIO.
 
 
 Linux boot command line
@@ -119,7 +119,7 @@ The following are some recommendations on GRUB boot settings:
 
       isolcpus=2,3,4,5,6,7,8
 
-#. If it wants to use VFIO, use the following additional grub parameters::
+#. To use VFIO, use the following additional grub parameters::
 
       iommu=pt intel_iommu=on
 
@@ -181,5 +181,5 @@ Configurations before running DPDK
    **Note**: To get the best performance, ensure that the core and NICs are in the same socket.
    In the example above ``85:00.0`` is on socket 1 and should be used by cores on socket 1 for the best performance.
 
-#. Check which kernel drivers needs to be loaded and whether there is a need to unbind the network ports from their kernel drivers.
+#. Check which kernel drivers need to be loaded and whether there is a need to unbind the network ports from their kernel drivers.
    More details about DPDK setup and Linux kernel requirements see :ref:`linux_gsg_compiling_dpdk` and :ref:`linux_gsg_linux_drivers`.
-- 
2.51.0

[PATCH 06/11] doc: correct word choice and redundant text in intro

[Stephen Hemminger]

Replace "customers" with "users" as DPDK is an open source project.
Remove redundant "(linux)" parenthetical after "Linux application".

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/intro.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst
index f5fd016a60..03df4f9a33 100644
--- a/doc/guides/linux_gsg/intro.rst
+++ b/doc/guides/linux_gsg/intro.rst
@@ -5,8 +5,8 @@ Introduction
 ============
 
 This document contains instructions for installing and configuring the Data Plane Development Kit (DPDK) software.
-It is designed to get customers up and running quickly.
-The document describes how to compile and run a DPDK application in a Linux application (linux) environment,
+It is designed to get users up and running quickly.
+The document describes how to compile and run a DPDK application in a Linux application environment,
 without going deeply into detail.
 
 Documentation Roadmap
-- 
2.51.0

[PATCH 07/11] doc: correct grammar in ARM64 cross-compile guide

[Stephen Hemminger]

Change "files... is" to "files... are" for subject-verb agreement.
Use consistent spelling "toolchain" instead of "tool chain".
Change "distribution" to "distributions" for plural form.
Rephrase "Substitute <target_soc> with" for clarity.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
index e4de5c8d18..82dde17c35 100644
--- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
+++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
@@ -44,7 +44,7 @@ NUMA is required by most modern machines, not needed for non-NUMA architectures.
    using the below guide. If you're using a different compiler,
    make sure you're using the proper executable name.
 
-The numa header files and lib file is generated in the include and lib folder
+The numa header files and lib file are generated in the include and lib folders
 respectively under ``<numa install dir>``.
 
 Meson prerequisites
@@ -185,7 +185,7 @@ provided the cross file has been modified accordingly::
 LLVM/Clang toolchain
 --------------------
 
-Obtain the cross tool chain
+Obtain the cross toolchain
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The latest LLVM/Clang cross compiler toolchain can be downloaded from:
@@ -236,7 +236,7 @@ use the following command to cross-compile DPDK for the target machine::
 Cross Compiling DPDK with LLVM/Clang toolchain using Meson on Ubuntu 18.04
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-On most popular Linux distribution it is not necessary to download
+On most popular Linux distributions, it is not necessary to download
 the toolchains, but rather use the packages provided by said distributions.
 On Ubuntu 18.04, these packages are needed:
 
@@ -260,7 +260,7 @@ option::
 
    meson setup soc_build -Dplatform=<target_soc>
 
-Substitute <target_soc> with one of the supported SoCs
+Replace <target_soc> with one of the supported SoCs.
 
 .. literalinclude:: ../../../config/arm/meson.build
    :start-after: Start of SoCs list
-- 
2.51.0

[PATCH 08/11] doc: remove redundant text in documentation roadmap

[Stephen Hemminger]

Remove redundant "(linux)" parenthetical that duplicates information
already conveyed by "Linux* application".

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/doc_roadmap.include.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/guides/linux_gsg/doc_roadmap.include.rst b/doc/guides/linux_gsg/doc_roadmap.include.rst
index 6686975f7b..5042c386c2 100644
--- a/doc/guides/linux_gsg/doc_roadmap.include.rst
+++ b/doc/guides/linux_gsg/doc_roadmap.include.rst
@@ -17,7 +17,7 @@ The following is a list of DPDK documents in the suggested reading order:
 *   :doc:`../prog_guide/index`: Describes:
 
     *   The software architecture and how to use it (through examples),
-        specifically in a Linux* application (linux) environment
+        specifically in a Linux* application environment
 
     *   The content of the DPDK, the build system (including the commands
         that can be used to build the development kit and an application)
-- 
2.51.0

[PATCH 09/11] doc: correct grammar and formatting in EAL arguments

[Stephen Hemminger]

Lowercase "Within" mid-sentence.
Use consistent directive case ".. note::" instead of ".. Note::".
Change "in to" to "into" (one word).
Add missing "be" in "will be created".
Use consistent bullet point spacing.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/eal_args.include.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/doc/guides/linux_gsg/eal_args.include.rst b/doc/guides/linux_gsg/eal_args.include.rst
index 4a3c4d9b5f..a0c17da9b9 100644
--- a/doc/guides/linux_gsg/eal_args.include.rst
+++ b/doc/guides/linux_gsg/eal_args.include.rst
@@ -17,7 +17,7 @@ Lcore-related options
 
        <lcores[@cpus]>[<,lcores[@cpus]>...]
 
-    Lcore and CPU lists are grouped by ``(`` and ``)`` Within the group.
+    Lcore and CPU lists are grouped by ``(`` and ``)`` within the group.
     The ``-`` character is used as a range separator and ``,`` is used as a
     single number separator.
     The grouping ``()`` can be omitted for single element group.
@@ -106,14 +106,14 @@ Device-related options
     Skip probing a PCI device to prevent EAL from using it.
     Multiple -b options are allowed.
 
-.. Note::
+.. note::
     Block list cannot be used with the allow list ``-a`` option.
 
 *   ``-a, --allow <[domain:]bus:devid.func>``
 
-    Add a PCI device in to the list of devices to probe.
+    Add a PCI device into the list of devices to probe.
 
-.. Note::
+.. note::
     Allow list cannot be used with the block list ``-b`` option.
 
 *   ``--vdev <device arguments>``
@@ -223,7 +223,7 @@ Debugging options
 
         --trace-dir=/tmp
 
-    By default, trace output will created at ``home`` directory and parameter
+    By default, trace output will be created at the ``home`` directory and parameter
     must be specified once only.
 
 *   ``--trace-bufsz=<val>``
@@ -266,15 +266,15 @@ Other options
 
     Pool ops name for mbuf to use.
 
-*    ``--telemetry``:
+*   ``--telemetry``:
 
     Enable telemetry (enabled by default).
 
-*    ``--no-telemetry``:
+*   ``--no-telemetry``:
 
     Disable telemetry.
 
-*    ``--force-max-simd-bitwidth=<val>``:
+*   ``--force-max-simd-bitwidth=<val>``:
 
     Specify the maximum SIMD bitwidth size to handle. This limits which vector paths,
     if any, are taken, as any paths taken must use a bitwidth below the max bitwidth limit.
-- 
2.51.0

[PATCH 10/11] doc: correct typos in enabling functionality guide

[Stephen Hemminger]

Remove space before hyphen in "frequency-based".
Change "can not" to "cannot" (one word).
Change "my" to "may" (typo).

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/enable_func.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
index a551ddebec..4e1a939f35 100644
--- a/doc/guides/linux_gsg/enable_func.rst
+++ b/doc/guides/linux_gsg/enable_func.rst
@@ -104,7 +104,7 @@ Power Management and Power Saving Functionality
 -----------------------------------------------
 
 Enhanced Intel SpeedStep\ |reg| Technology must be enabled in the platform BIOS if the power management feature of DPDK is to be used.
-Otherwise, the sys file folder ``/sys/devices/system/cpu/cpu0/cpufreq`` will not exist, and the CPU frequency- based power management cannot be used.
+Otherwise, the sys file folder ``/sys/devices/system/cpu/cpu0/cpufreq`` will not exist, and the CPU frequency-based power management cannot be used.
 Consult the relevant BIOS documentation to determine how these settings can be accessed.
 
 For example, on some Intel reference platform BIOS variants, the path to Enhanced Intel SpeedStep\ |reg| Technology is::
@@ -134,7 +134,7 @@ to isolate them from the general Linux scheduler tasks.
 .. note::
 
    It is not recommended to use CPU core 0 for DPDK polling applications
-   because it can not be truly isolated from other system and kernel activity.
+   because it cannot be truly isolated from other system and kernel activity.
 
 For example, if a given CPU has 0-7 cores
 and DPDK applications are to run on logical cores 2, 4 and 6,
@@ -173,7 +173,7 @@ To enable HPET support in DPDK:
 
 #. Ensure that HPET is enabled in BIOS settings.
 #. Enable ``HPET_MMAP`` support in kernel configuration.
-   Note that this my involve doing a kernel rebuild,
+   Note that this may involve doing a kernel rebuild,
    as many common linux distributions do *not* have this setting
    enabled by default in their kernel builds.
 #. Enable DPDK support for HPET by using the build-time meson option ``use_hpet``,
-- 
2.51.0

[PATCH 11/11] doc: correct grammar in Linux drivers guide

[Stephen Hemminger]

Add missing space after comma in device list.
Add possessive apostrophe in "distribution's documentation".
Change "co-exists" to "co-exist" for subject-verb agreement.
Correct cross-reference direction from "below" to "above".

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/linux_gsg/linux_drivers.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 739fc0226c..a7d64d486c 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -90,7 +90,7 @@ To see the status of all network ports on the system:
     =====================
     <none>
 
-To bind device ``eth1``,``04:00.1``, to the ``vfio-pci`` driver:
+To bind device ``eth1``, ``04:00.1``, to the ``vfio-pci`` driver:
 
 .. code-block:: console
 
@@ -120,7 +120,7 @@ To make use of VFIO, the ``vfio-pci`` module must be loaded:
     sudo modprobe vfio-pci
 
 VFIO kernel is usually present by default in all distributions,
-however please consult your distributions documentation to make sure that is the case.
+however please consult your distribution's documentation to make sure that is the case.
 
 To make use of full VFIO functionality,
 both kernel and BIOS must support and be configured
@@ -358,7 +358,7 @@ or PMD name matches platform device name, all in that order.
 
 VFIO Platform depends on ARM/ARM64 and is usually enabled on distributions
 running on these systems.
-Consult your distributions documentation to make sure that is the case.
+Consult your distribution's documentation to make sure that is the case.
 
 
 .. _bifurcated_driver:
@@ -366,7 +366,7 @@ Consult your distributions documentation to make sure that is the case.
 Bifurcated Driver
 -----------------
 
-PMDs which use the bifurcated driver co-exists with the device kernel driver.
+PMDs which use the bifurcated driver co-exist with the device kernel driver.
 On such model the NIC is controlled by the kernel, while the data
 path is performed by the PMD directly on top of the device.
 
@@ -428,7 +428,7 @@ It can be loaded as shown below:
    the Linux kernel may disallow the use of UIO on the system.
    Therefore, devices for use by DPDK should be bound to the ``vfio-pci`` kernel module
    rather than any UIO-based module.
-   For more details see :ref:`linux_gsg_binding_kernel` below.
+   For more details see :ref:`linux_gsg_binding_kernel` above.
 
 .. note::
 
-- 
2.51.0

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

[Thomas Monjalon]

16/01/2026 22:06, Stephen Hemminger:
> 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.

Squashed and applied, thanks.