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 09/11] doc: correct grammar and formatting in EAL arguments
Date: Fri, 16 Jan 2026 13:06:25 -0800	[thread overview]
Message-ID: <20260116211649.104776-10-stephen@networkplumber.org> (raw)
In-Reply-To: <20260116211649.104776-1-stephen@networkplumber.org>

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


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

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-16 21:06 [PATCH 00/11] doc: Linux Getting Started Guide grammar and clarity improvements Stephen Hemminger
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 ` Stephen Hemminger [this message]
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-10-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