DPDK-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 06/15] doc: correct capitalization and formatting in ethtool guide
Date: Thu, 11 Jun 2026 14:18:45 -0700	[thread overview]
Message-ID: <20260611212119.1026721-7-stephen@networkplumber.org> (raw)
In-Reply-To: <20260611212119.1026721-1-stephen@networkplumber.org>

Correct consistency issues in the ethtool sample application guide:
- Changed "sub-directory" to "subdirectory" for consistency
- Fixed heading capitalization inconsistencies
- Corrected "Ethtool" to "ethtool" where appropriate
- Fixed "call-back" to "callback" (single word)
- Improved sentence structure and readability

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

diff --git a/doc/guides/sample_app_ug/ethtool.rst b/doc/guides/sample_app_ug/ethtool.rst
index 8bb8b73922..68bcf25b1f 100644
--- a/doc/guides/sample_app_ug/ethtool.rst
+++ b/doc/guides/sample_app_ug/ethtool.rst
@@ -20,9 +20,9 @@ Compiling the Application
 
 To compile the sample application see :doc:`compiling`.
 
-The application is located in the ``ethtool`` sub-directory.
+The application is located in the ``ethtool`` subdirectory.
 
-Running the Application
+Running the application
 -----------------------
 
 The application requires an available core for each port, plus one.
@@ -43,7 +43,7 @@ The application is console-driven using the cmdline DPDK interface:
         EthApp>
 
 From this interface, the available commands and descriptions
-of what they do are as follows:
+are as follows:
 
 * ``drvinfo``: Print driver info
 * ``eeprom``: Dump EEPROM to file
@@ -67,8 +67,8 @@ Explanation
 -----------
 
 The sample program has two parts: A background `packet reflector`_
-that runs on a worker core, and a foreground `Ethtool Shell`_ that
-runs on the main core. These are described below.
+that runs on a worker core, and a foreground `ethtool shell`_ that
+runs on the main core.
 
 Packet Reflector
 ~~~~~~~~~~~~~~~~
@@ -82,11 +82,11 @@ source address, and is then sent out on the same port.
 Ethtool Shell
 ~~~~~~~~~~~~~
 
-The foreground part of the Ethtool sample is a console-based
+The foreground part of the ethtool sample is a console-based
 interface that accepts commands as described in `running the
-application`_. Individual call-back functions handle the detail
+Running the application`_. Individual callback functions handle the detail
 associated with each command, which make use of the functions
-defined in the `Ethtool interface`_ to the DPDK functions.
+defined in the `ethtool interface`_ to the DPDK functions.
 
 Ethtool interface
 -----------------
-- 
2.53.0


  parent reply	other threads:[~2026-06-11 21:22 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-27 17:47 [PATCH] doc: reword sample application guides Nandini Persad
2025-02-16 23:09 ` [PATCH v2] " Nandini Persad
2025-02-20 12:26   ` Burakov, Anatoly
2026-06-11 21:18   ` [PATCH 00/15] doc: clean up " Stephen Hemminger
2026-06-11 21:18     ` [PATCH 01/15] doc: cleanups to bbdev sample application Stephen Hemminger
2026-06-11 21:18     ` [PATCH 02/15] doc: cleanup cmd_line example documentation Stephen Hemminger
2026-06-11 21:18     ` [PATCH 03/15] doc: cleanup the distribution sample application guide Stephen Hemminger
2026-06-11 21:18     ` [PATCH 04/15] doc: improve structure and clarity of compiling guide Stephen Hemminger
2026-06-11 21:18     ` [PATCH 05/15] doc: improve clarity and consistency in DMA sample app guide Stephen Hemminger
2026-06-15  9:50       ` fengchengwen
2026-06-11 21:18     ` Stephen Hemminger [this message]
2026-06-11 21:18     ` [PATCH 07/15] doc: improve clarity in eventdev, FIPS, and flow filtering Stephen Hemminger
2026-06-11 21:18     ` [PATCH 08/15] doc: enhance hello_world, intro, IP frag and pipeline Stephen Hemminger
2026-06-11 21:18     ` [PATCH 09/15] doc: improve IP reassembly, IPsec, multicast, and keep-alive Stephen Hemminger
2026-06-12 10:06       ` Radu Nicolau
2026-06-11 21:18     ` [PATCH 10/15] doc: enhance L2 forwarding sample application guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 11/15] doc: enhance multi-process, NTB, ordering, and PTP guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 12/15] doc: improve QoS, callbacks, EFD, and service cores guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 13/15] doc: enhance skeleton, pipeline, timer, and vhost guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 14/15] doc: improve vhost, VM power, and VMDq sample guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 15/15] doc: correct grammar and punctuation consistency issues Stephen Hemminger
2026-06-12 10:06       ` Radu Nicolau

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=20260611212119.1026721-7-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