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

Stephen Hemminger
2026-01-16T21:17:47Z

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