public inbox for netdev@vger.kernel.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: netdev@vger.kernel.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page
Date: Sat, 24 Jan 2026 11:49:28 -0800	[thread overview]
Message-ID: <20260124195824.221305-5-stephen@networkplumber.org> (raw)
In-Reply-To: <20260124195824.221305-1-stephen@networkplumber.org>

This patch addresses grammatical errors and style inconsistencies in
the netshaper man page documentation.

Changes:
  - Improve clarity of set command description by restructuring
    awkward parenthetical about id parameter
  - Fix punctuation consistency in scope list formatting
  - Capitalize "ID" in example heading for proper title case
  - Add missing article "the" in color option description (3 instances)
  - Make example descriptions consistent by using present tense
    third person ("Displays", "Removes") to match Example 1

No functional changes. All technical content remains accurate.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 man/man8/netshaper.8 | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/man/man8/netshaper.8 b/man/man8/netshaper.8
index b9fdc0d3..f5fe36cc 100644
--- a/man/man8/netshaper.8
+++ b/man/man8/netshaper.8
@@ -77,9 +77,9 @@ parameter is required.
 .B netshaper set
 - Create or update a shaper configuration
 
-Creates or updates a shaper with the specified parameters. All parameters except
+Creates or updates a shaper with the specified parameters. The
 .I id
-(for netdev scope) are required.
+parameter is optional for netdev scope but required for all other scopes.
 
 .SS
 .B netshaper show
@@ -109,7 +109,8 @@ Defines the shaper handle consisting of:
 .BI scope " HANDLE_SCOPE"
 The shaper scope, which can be:
 .BR netdev " (device-level shaper), "
-.BR queue " (queue-level shaper), or "
+.BR queue " (queue-level shaper), "
+or
 .BR node " (scheduling node shaper)."
 
 .TP
@@ -139,11 +140,11 @@ utility and exit.
 
 .TP
 .BR \-c [ color "] = {" always " | " auto " | " never }
-Configure color output. If parameter is omitted or
+Configure color output. If the parameter is omitted or
 .BR always ,
-color output is enabled regardless of stdout state. If parameter is
+color output is enabled regardless of stdout state. If the parameter is
 .BR auto ,
-stdout is checked to be a terminal before enabling color output. If parameter is
+stdout is checked to be a terminal before enabling color output. If the parameter is
 .BR never ,
 color output is disabled. If specified multiple times, the last one takes
 precedence.
@@ -155,7 +156,7 @@ Display usage information and exit.
 .SH EXAMPLES
 
 .TP
-.B Example 1: Create a device-level shaper (id optional)
+.B Example 1: Create a device-level shaper (ID optional)
 .nf
 # netshaper set dev foo handle scope netdev bw-max 10gbit
 .fi
@@ -170,7 +171,7 @@ bandwidth to 10 gigabits per second.
 # netshaper show dev foo handle scope netdev
 .fi
 .RS
-Display the current shaper configuration for the specified device and handle.
+Displays the current shaper configuration for the specified device and handle.
 .RE
 
 .TP
@@ -179,7 +180,7 @@ Display the current shaper configuration for the specified device and handle.
 # netshaper delete dev eth0 handle scope netdev
 .fi
 .RS
-Remove the specified shaper configuration.
+Removes the specified shaper configuration.
 .RE
 
 .SH NOTES
-- 
2.51.0


  parent reply	other threads:[~2026-01-24 19:58 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 1/7] dcb: fix grammar and style issues in man pages Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 2/7] devlink: " Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 3/7] fix grammar and style issues in man pages for stat related pages Stephen Hemminger
2026-01-24 19:49 ` Stephen Hemminger [this message]
2026-01-24 19:49 ` [PATCH iproute2-next 5/7] tipc: fix grammar and style issues in man pages Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 6/7] vdpa: fix grammar, titles, and formatting " Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 7/7] rdma: fix grammar, formatting, and style " Stephen Hemminger
2026-01-31 19:20 ` [PATCH iproute2-next 0/7] man page corrections patchwork-bot+netdevbpf

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=20260124195824.221305-5-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=netdev@vger.kernel.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