netdev - [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20260124195824.221305-5-stephen@networkplumber.org>
Date: Sat, 24 Jan 2026 11:49:28 -0800
From: Stephen Hemminger <stephen@...workplumber.org>
To: netdev@...r.kernel.org
Cc: Stephen Hemminger <stephen@...workplumber.org>
Subject: [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page

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@...workplumber.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