* [PATCH iproute2-next 1/7] dcb: fix grammar and style issues in man pages
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
@ 2026-01-24 19:49 ` Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 2/7] devlink: " Stephen Hemminger
` (6 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses various grammatical errors, style inconsistencies,
and clarity issues across the DCB man page documentation.
Changes by file:
dcb.8:
- Capitalize first word of -n option description
- Add missing article "The" in -b option description
- Fix verb form "shown" -> "show" in -s option description
- Add missing dcb-dcbx(8) reference in SEE ALSO section
dcb-app.8:
- Add missing article "the" before "APP table"
- Fix singular/plural: "value" -> "values"
- Improve phrasing: "priority of both 1 and 2" -> "priorities 1 and 2"
- Make command descriptions consistent (present tense)
- Simplify relative clause construction in default-prio description
- Fix PCP/DEI description formatting and punctuation
dcb-apptrust.8:
- Remove inappropriate period in NAME section
- Improve clarity by removing unnecessary commas and redundant phrasing
- Use present tense instead of future in DESCRIPTION
- Make command descriptions consistent with proper articles
dcb-buffer.8:
- Remove unnecessary "be" in DESCRIPTION
- Add missing comma in prio-buffer parameter description
dcb-dcbx.8:
- Capitalize first word of static parameter description
dcb-ets.8:
- Add missing commas after introductory phrases in prio-tc and
tc-tsa parameter descriptions
dcb-rewr.8:
- Capitalize month name in TH date
- Fix subject-verb agreement and plural forms in DESCRIPTION
- Make command descriptions consistent (present tense)
- Fix PCP/DEI description formatting and punctuation
- Add missing commas in SEE ALSO section
- Fix spacing in REPORTING BUGS section
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/dcb-app.8 | 24 ++++++++++++------------
man/man8/dcb-apptrust.8 | 16 ++++++++--------
man/man8/dcb-buffer.8 | 4 ++--
man/man8/dcb-dcbx.8 | 2 +-
man/man8/dcb-ets.8 | 4 ++--
man/man8/dcb-rewr.8 | 34 +++++++++++++++++-----------------
man/man8/dcb.8 | 7 ++++---
7 files changed, 46 insertions(+), 45 deletions(-)
diff --git a/man/man8/dcb-app.8 b/man/man8/dcb-app.8
index be505a0b..dea36a2f 100644
--- a/man/man8/dcb-app.8
+++ b/man/man8/dcb-app.8
@@ -81,9 +81,9 @@ the DCB (Data Center Bridging) subsystem
.SH DESCRIPTION
.B dcb app
-is used to configure APP table, or application priority table in the DCB (Data
+is used to configure the APP table, or application priority table in the DCB (Data
Center Bridging) subsystem. The APP table is used to assign priority to traffic
-based on value in one of several headers: EtherType, L4 destination port, or
+based on values in one of several headers: EtherType, L4 destination port, or
DSCP. It also allows configuration of port-default priority that is chosen if no
other prioritization rule applies.
@@ -99,7 +99,7 @@ The APP table is a set of DCB APP entries. The only requirement is that
duplicate entries are not added. Notably, it is valid to have conflicting
priority assignment for the same selector and protocol ID. For example, the set
of two APP entries (DSCP, 10, 1) and (DSCP, 10, 2), where packets with DSCP of
-10 should get priority of both 1 and 2, form a well-defined APP table. The
+10 should get priorities 1 and 2, form a well-defined APP table. The
.B dcb app
tool allows low-level management of the app table by adding and deleting
individual APP 3-tuples through
@@ -116,12 +116,12 @@ prioritization is in effect for a given selector and protocol ID.
.TP
.B show
-Display all entries with a given selector. When no selector is given, shows all
+Displays all entries with a given selector. When no selector is given, shows all
APP table entries categorized per selector.
.TP
.B flush
-Remove all entries with a given selector. When no selector is given, removes all
+Removes all entries with a given selector. When no selector is given, removes all
APP table entries.
.TP
@@ -133,11 +133,11 @@ table.
.TP
.B replace
-Take the list of entries mentioned as parameter, and add those that are not
-present in the APP table yet. Then remove those entries, whose selector and
+Takes the list of entries mentioned as parameter, and adds those that are not
+present in the APP table yet. Then removes those entries, whose selector and
protocol ID have been mentioned as parameter, but not with the exact same
priority. This has the effect of, for the given selector and protocol ID,
-causing that the table only contains the priority (or priorities) given as
+ensuring that the table only contains the priority (or priorities) given as
parameter.
.SH PARAMETERS
@@ -148,7 +148,7 @@ the parameter name is to be used as a simple keyword without further arguments.
.TP
.B default-prio \fIPRIO-LIST
-The priority to be used for traffic the priority of which is otherwise
+The priority to be used for traffic whose priority is otherwise
unspecified. The argument is a list of individual priorities. Note that
.B default-prio
rules are configured as triplets (\fBEtherType\fR, \fB0\fR, \fIPRIO\fR).
@@ -198,9 +198,9 @@ turns the show translation off.
\fIPCP-MAP\fR uses the array parameter syntax, see
.BR dcb (8)
for details. Keys are PCP/DEI. Values are priorities assigned to traffic with
-matching PCP/DEI. PCP/DEI values are written as a combination of numeric- and
-symbolic values, to accommodate for both. PCP always in numerical form e.g
-0 .. 7 and DEI in symbolic form e.g 'de' (drop-eligible), indicating that the
+matching PCP/DEI. PCP/DEI values are written as a combination of numeric and
+symbolic values, to accommodate both. PCP is always in numerical form, e.g.,
+0 .. 7 and DEI in symbolic form, e.g., 'de' (drop-eligible), indicating that the
DEI bit is 1 or 'nd' (not-drop-eligible), indicating that the DEI bit is 0.
In combination 2de:1 translates to a mapping of PCP=2 and DEI=1 to priority 1.
diff --git a/man/man8/dcb-apptrust.8 b/man/man8/dcb-apptrust.8
index ddc2133f..77ac0a4a 100644
--- a/man/man8/dcb-apptrust.8
+++ b/man/man8/dcb-apptrust.8
@@ -1,7 +1,7 @@
.TH DCB-APPTRUST 8 "22 November 2022" "iproute2" "Linux"
.SH NAME
dcb-apptrust \- show / configure per-selector trust and trust order of the
-application priority table of the DCB (Data Center Bridging) subsystem.
+application priority table of the DCB (Data Center Bridging) subsystem
.SH SYNOPSIS
.sp
.ad l
@@ -39,21 +39,21 @@ Application Priority Table, see
.BR dcb-app (8)
for details on how to configure app table entries.
-Selector trust can be used by the
-software stack, or drivers (most likely the latter), when querying the APP
-table, to determine if an APP entry should take effect, or not. Additionally, the
-order of the trusted selectors will dictate which selector should take
-precedence, in the case of multiple different APP table selectors being present.
+Selector trust can be used by the software stack or drivers (most likely the
+latter) when querying the APP table, to determine whether an APP entry should
+take effect. Additionally, the order of the trusted selectors dictates which
+selector should take precedence, in the case of multiple different APP table
+selectors being present.
.SH COMMANDS
.TP
.B show
-Display all trusted selectors.
+Displays all trusted selectors.
.TP
.B set
-Set new list of trusted selectors. Empty list is effectively the same as
+Sets a new list of trusted selectors. An empty list is effectively the same as
removing trust entirely.
.SH PARAMETERS
diff --git a/man/man8/dcb-buffer.8 b/man/man8/dcb-buffer.8
index c7ba6a99..4d9e6f40 100644
--- a/man/man8/dcb-buffer.8
+++ b/man/man8/dcb-buffer.8
@@ -52,7 +52,7 @@ the DCB (Data Center Bridging) subsystem
.B dcb buffer
is used to configure assignment of traffic to port buffers based on traffic
-priority, and sizes of those buffers. It can be also used to inspect the current
+priority, and sizes of those buffers. It can also be used to inspect the current
configuration, as well as total device memory that the port buffers take.
.SH PARAMETERS
@@ -73,7 +73,7 @@ there are any hidden or internal buffers.
.B prio-buffer \fIPRIO-MAP
\fIPRIO-MAP\fR uses the array parameter syntax, see
.BR dcb (8)
-for details. Keys are priorities, values are buffer indices. For each priority
+for details. Keys are priorities, values are buffer indices. For each priority,
sets a buffer where traffic with that priority is directed to.
.TP
diff --git a/man/man8/dcb-dcbx.8 b/man/man8/dcb-dcbx.8
index bafc18f6..b06617ad 100644
--- a/man/man8/dcb-dcbx.8
+++ b/man/man8/dcb-dcbx.8
@@ -74,7 +74,7 @@ does not mandate this.
.TP
.B static
-indicates the engine supports static configuration. No actual negotiation is
+Indicates the engine supports static configuration. No actual negotiation is
performed, negotiated parameters are always the initial configuration.
.SH EXAMPLE & USAGE
diff --git a/man/man8/dcb-ets.8 b/man/man8/dcb-ets.8
index 9c64b33e..9373d640 100644
--- a/man/man8/dcb-ets.8
+++ b/man/man8/dcb-ets.8
@@ -101,7 +101,7 @@ Whether local host should accept configuration from peer TLVs.
.B reco-prio-tc \fIPRIO-MAP
\fIPRIO-MAP\fR uses the array parameter syntax, see
.BR dcb (8)
-for details. Keys are priorities, values are traffic classes. For each priority
+for details. Keys are priorities, values are traffic classes. For each priority,
sets a TC where traffic with that priority is directed to.
.TP
@@ -111,7 +111,7 @@ sets a TC where traffic with that priority is directed to.
\fITSA-MAP\fR uses the array parameter syntax, see
.BR dcb (8)
for details. Keys are TCs, values are Transmission Selection Algorithm (TSA)
-keywords described below. For each TC sets an algorithm used for deciding how
+keywords described below. For each TC, sets an algorithm used for deciding how
traffic queued up at this TC is scheduled for transmission. Supported TSAs are:
.B strict
diff --git a/man/man8/dcb-rewr.8 b/man/man8/dcb-rewr.8
index 03b59cf4..a2ee704c 100644
--- a/man/man8/dcb-rewr.8
+++ b/man/man8/dcb-rewr.8
@@ -1,4 +1,4 @@
-.TH DCB-REWR 8 "15 may 2023" "iproute2" "Linux"
+.TH DCB-REWR 8 "15 May 2023" "iproute2" "Linux"
.SH NAME
dcb-rewr \- show / manipulate the rewrite table of
the DCB (Data Center Bridging) subsystem
@@ -59,11 +59,11 @@ ID, and priority. Selector is an enumeration that picks one of the
prioritization namespaces. Currently, only the DSCP and PCP selector namespaces
are supported by dcb rewr.
-The rewrite table is a list of DCB rewrite rules, that applies to packets
-with matching priority. Notably, it is valid to have conflicting rewrite
-assignment for the same selector and priority. For example, the set of two
+The rewrite table is a list of DCB rewrite rules that applies to packets
+with matching priority. Notably, it is valid to have conflicting rewrite
+assignments for the same selector and priority. For example, the set of two
rewrite entries (DSCP, 10, 1) and (DSCP, 11, 1), where packets with priority 1
-should have its DSCP value rewritten to both 10 and 11, form a well-defined
+should have their DSCP values rewritten to both 10 and 11, form a well-defined
rewrite table.
.B dcb rewr
tool allows low-level management of the rewrite table by adding and deleting
@@ -81,12 +81,12 @@ rewrite rule is in effect for a given selector and priority.
.TP
.B show
-Display all entries with a given selector. When no selector is given, shows all
+Displays all entries with a given selector. When no selector is given, shows all
rewrite table entries categorized per selector.
.TP
.B flush
-Remove all entries with a given selector. When no selector is given, removes all
+Removes all entries with a given selector. When no selector is given, removes all
rewrite table entries.
.TP
@@ -98,11 +98,11 @@ rewrite table.
.TP
.B replace
-Take the list of entries mentioned as parameter, and add those that are not
-present in the rewrite table yet. Then remove those entries, whose selector and
+Takes the list of entries mentioned as parameter, and adds those that are not
+present in the rewrite table yet. Then removes those entries, whose selector and
priority have been mentioned as parameter, but not with the exact same
protocol ID. This has the effect of, for the given selector and priority,
-causing that the table only contains the protocol ID (or ID's) given as
+ensuring that the table only contains the protocol ID (or IDs) given as
parameter.
.SH PARAMETERS
@@ -134,10 +134,10 @@ turns the show translation off.
\fIPCP-MAP\fR uses the array parameter syntax, see
.BR dcb (8)
for details. Keys are priorities. Values are PCP/DEI for traffic with
-matching priority. PCP/DEI values are written as a combination of numeric- and
-symbolic values, to accommodate for both. PCP always in numeric form e.g 0 ..
-7 and DEI in symbolic form e.g 'de' (drop-eligible), indicating that the DEI
-bit is 1 or 'nd' (not-drop-eligible), indicating that the DEI bit is 0. In
+matching priority. PCP/DEI values are written as a combination of numeric and
+symbolic values, to accommodate both. PCP is always in numeric form, e.g., 0 ..
+7 and DEI in symbolic form, e.g., 'de' (drop-eligible), indicating that the DEI
+bit is 1 or 'nd' (not-drop-eligible), indicating that the DEI bit is 0. In
combination 1:2de translates to a mapping of priority 1 to PCP=2 and DEI=1.
.SH EXAMPLE & USAGE
@@ -192,14 +192,14 @@ prio-pcp 1:1nd 2:2de
Exit status is 0 if command was successful or a positive integer upon failure.
.SH SEE ALSO
-.BR dcb (8)
-.BR dcb-app (8)
+.BR dcb (8),
+.BR dcb-app (8),
.BR dcb-apptrust (8)
.SH REPORTING BUGS
Report any bugs to the Network Developers mailing list
.B <netdev@vger.kernel.org>
-where the development and maintenance is primarily done. You do not have to be
+where the development and maintenance is primarily done. You do not have to be
subscribed to the list to send a message there.
.SH AUTHOR
diff --git a/man/man8/dcb.8 b/man/man8/dcb.8
index a1d6505e..f04fa7b7 100644
--- a/man/man8/dcb.8
+++ b/man/man8/dcb.8
@@ -29,7 +29,7 @@ dcb \- show / manipulate DCB (Data Center Bridging) settings
.TP
.BR "\-n" , " \--netns " <NETNS>
-switches
+Switches
.B dcb
to the specified network namespace
.IR NETNS .
@@ -42,7 +42,7 @@ utility and exit.
.TP
.BR "\-b", " --batch " <FILENAME>
-Read commands from provided file or standard input and invoke them. First
+Read commands from provided file or standard input and invoke them. The first
failure will cause termination of dcb.
.TP
@@ -70,7 +70,7 @@ When combined with -j generate a pretty JSON output.
.TP
.BR "\-s" , " --statistics"
-If the object in question contains any statistical counters, shown them as
+If the object in question contains any statistical counters, show them as
part of the "show" output.
.SH OBJECTS
@@ -142,6 +142,7 @@ Exit status is 0 if command was successful or a positive integer upon failure.
.BR dcb-app (8),
.BR dcb-apptrust (8),
.BR dcb-buffer (8),
+.BR dcb-dcbx (8),
.BR dcb-ets (8),
.BR dcb-maxrate (8),
.BR dcb-pfc (8),
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 2/7] devlink: fix grammar and style issues in man pages
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 ` 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
` (5 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses various grammatical errors, style inconsistencies,
and clarity issues across the devlink man page documentation.
Changes by file:
devlink.8:
- Add missing article "The" in -b option description
- Add missing periods in object descriptions (region, health, trap)
- Update synopsis to include all objects (rate, lc, dpipe)
- Add descriptions for rate, lc, and dpipe objects
- Add complete cross-references in SEE ALSO section
devlink-dev.8:
- Change "HWs" to "hardware devices" for clarity
- Fix verb form: "restart driver" -> "restarting the driver"
- Fix plural agreement: "some driver" -> "some drivers"
- Fix typo: "actrually" -> "actually"
devlink-port.8:
- Capitalize "Set port type" parameter description
- Fix preposition: "split to" -> "split into"
- Fix punctuation: "on. or" -> "on, or"
- Rewrite pfnum description for grammatical clarity
- Fix plural agreement: "devices which supports" -> "devices which support"
- Fix article: "a Ethernet" -> "an Ethernet"
- Fix verb form: "restart driver" -> "restarting the driver"
- Fix typo: "Unplit" -> "Unsplit"
- Fix verb form: "active the function" -> "activate the function"
devlink-rate.8:
- Fix plural agreement: "some driver" -> "some drivers"
- Fix possessive pronouns: "it's" -> "its" (3 instances)
- Fix plural: "leaf have" -> "leaves have"
- Add article: "create leaf rate object" -> "create a leaf rate object"
- Format "1to1" as "1-to-1"
- Fix plural: "These parameter" -> "These parameters"
- Add verb: "parent node applied" -> "parent node are applied"
- Fix spelling: "behaviour" -> "behavior"
- Improve phrasing: "treated as parent unset" -> "is treated as unsetting the parent"
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/devlink-dev.8 | 8 ++++----
man/man8/devlink-port.8 | 18 +++++++++---------
man/man8/devlink-rate.8 | 18 +++++++++---------
man/man8/devlink.8 | 25 ++++++++++++++++++++-----
4 files changed, 42 insertions(+), 27 deletions(-)
diff --git a/man/man8/devlink-dev.8 b/man/man8/devlink-dev.8
index e9d091df..d10b1f9a 100644
--- a/man/man8/devlink-dev.8
+++ b/man/man8/devlink-dev.8
@@ -127,7 +127,7 @@ Set eswitch mode
.TP
.BR inline-mode " { " none " | " link " | " network " | " transport " } "
-Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.
+Some hardware devices need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.
.I none
- None
@@ -169,7 +169,7 @@ Configuration mode in which the new value is set.
- Set new value while driver is running. This configuration mode doesn't require any reset to apply the new value.
.I driverinit
-- Set new value which will be applied during driver initialization. This configuration mode requires restart driver by devlink reload command to apply the new value.
+- Set new value which will be applied during driver initialization. This configuration mode requires restarting the driver by devlink reload command to apply the new value.
.I permanent
- New value is written to device's non-volatile memory. This configuration mode requires hard reset to apply the new value.
@@ -198,9 +198,9 @@ If this argument is omitted
action will be used.
Note that even though user asks for a specific action, the driver implementation
might require to perform another action alongside with it. For example, some
-driver do not support driver reinitialization being performed without fw
+drivers do not support driver reinitialization being performed without fw
activation. Therefore, the devlink reload command returns the list of actions
-which were actrually performed.
+which were actually performed.
.I driver_reinit
- Driver entities re-initialization, applying devlink-param and
diff --git a/man/man8/devlink-port.8 b/man/man8/devlink-port.8
index 6f582260..a74ffecc 100644
--- a/man/man8/devlink-port.8
+++ b/man/man8/devlink-port.8
@@ -125,7 +125,7 @@ BUS_NAME/BUS_ADDRESS/PORT_INDEX
.TP
.BR type " { " eth " | " ib " | " auto " } "
-set port type
+Set port type.
.I eth
- Ethernet
@@ -144,7 +144,7 @@ set port type
.TP
.BI count " COUNT"
-number of ports to split to.
+Number of ports to split into.
.SS devlink port unsplit - unsplit previously split devlink port
Could be performed on any split port of the same split group.
@@ -168,7 +168,7 @@ Is an alias for
.SS devlink port add - add a devlink port
.PP
.I "DEV"
-- specifies the devlink device to operate on. or
+- specifies the devlink device to operate on, or
.PP
.I "DEV/PORT_INDEX"
@@ -187,12 +187,12 @@ set port flavour
.TP
.BI pfnum " PFNUMBER "
-Specifies PCI pfnumber to use on which a SF device to create
+Specifies the PCI PF number on which to create an SF device.
.TP
.BI sfnum " SFNUMBER "
Specifies sfnumber to assign to the device of the SF.
-This field is optional for those devices which supports auto assignment of the
+This field is optional for those devices which support auto assignment of the
SF number.
.TP
@@ -210,7 +210,7 @@ external controller.
.TP
.BI hw_addr " ADDR"
-Hardware address of the function to set. This is a Ethernet MAC address when
+Hardware address of the function to set. This is an Ethernet MAC address when
port type is Ethernet.
.TP
@@ -273,7 +273,7 @@ Configuration mode in which the new value is set.
- Set new value while driver is running. This configuration mode doesn't require any reset to apply the new value.
.I driverinit
-- Set new value which will be applied during driver initialization. This configuration mode requires restart driver by devlink reload command to apply the new value.
+- Set new value which will be applied during driver initialization. This configuration mode requires restarting the driver by devlink reload command to apply the new value.
.I permanent
- New value is written to device's non-volatile memory. This configuration mode requires hard reset to apply the new value.
@@ -317,7 +317,7 @@ Split the specified devlink port into four ports.
.PP
devlink port unsplit pci/0000:01:00.0/1
.RS 4
-Unplit the specified previously split devlink port.
+Unsplit the specified previously split devlink port.
.RE
.PP
devlink port health show
@@ -391,7 +391,7 @@ This will set the maximum number of IO event queues of the function to 4.
.PP
devlink port function set pci/0000:01:00.0/1 hw_addr 00:00:00:11:22:33 state active
.RS 4
-Configure hardware address and also active the function. When a function is
+Configure hardware address and also activate the function. When a function is
activated together with other configuration in a single command, all the
configuration is applied first before changing the state to active.
.RE
diff --git a/man/man8/devlink-rate.8 b/man/man8/devlink-rate.8
index 47e2ebc5..1689cba9 100644
--- a/man/man8/devlink-rate.8
+++ b/man/man8/devlink-rate.8
@@ -54,9 +54,9 @@ object can be presented by one of the two types:
.TP 8
.B leaf
Represents a single devlink port; created/destroyed by the driver and bound to
-the devlink port. As example, some driver may create leaf rate object for every
-devlink port associated with VF. Since leaf have 1to1 mapping to it's devlink
-port, in user space it is referred as corresponding devlink port
+the devlink port. As an example, some drivers may create a leaf rate object for every
+devlink port associated with VF. Since leaves have a 1-to-1 mapping to their devlink
+port, in user space they are referred to as corresponding devlink port
\fIDEV/PORT_INDEX\fR;
.TP 8
.B node
@@ -65,7 +65,7 @@ below) and bound to the devlink device rather then to the devlink port. In
userspace it is referred as \fIDEV/NODE_NAME\fR, where node name can be any,
except decimal number, to avoid collisions with leafs.
.PP
-Command output show rate object identifier, it's type and rate values along with
+Command output show rate object identifier, its type and rate values along with
parent node name. Rate values printed in SI units which are more suitable to
represent specific value. To print values in IEC units \fB-i\fR switch is
used. JSON (\fB-j\fR) output always print rate values in bytes per second. Zero
@@ -101,7 +101,7 @@ probability that the node will get selected for scheduling.
This arbitration scheme can be used simultaneously with the strict priority.
As a node is configured with a higher rate it gets more BW relative to it's
siblings. Values are relative like a percentage points, they basically tell
-how much BW should node take relative to it's siblings.
+how much BW should node take relative to its siblings.
.PP
.BI tc-bw " INDEX:N"
- allows the user to assign relative bandwidth shares to specific traffic
@@ -157,13 +157,13 @@ maps to the defined traffic classes under the IEEE 802.1Qaz standard.
.PP
.TP 8
.I N
-These parameter accept integer meaning weight or priority of a node.
+These parameters accept an integer meaning weight or priority of a node.
.PP
.BI parent " NODE_NAME \fR| " noparent
- set rate object parent to existing node with name \fINODE_NAME\fR or unset
-parent. Rate limits of the parent node applied to all it's children. Actual
-behaviour is details of driver's implementation. Setting parent to empty ("")
-name due to the kernel logic treated as parent unset.
+parent. Rate limits of the parent node are applied to all its children. Actual
+behavior is a detail of the driver's implementation. Setting parent to empty ("")
+name due to the kernel logic is treated as unsetting the parent.
.SS devlink port function rate add - create node rate object with specified parameters.
Creates rate object of type node and sets parameters. Parameters same as for the
diff --git a/man/man8/devlink.8 b/man/man8/devlink.8
index de53061b..9f1c42fb 100644
--- a/man/man8/devlink.8
+++ b/man/man8/devlink.8
@@ -7,7 +7,7 @@ devlink \- Devlink tool
.in +8
.ti -8
.B devlink
-.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health | trap " } { " COMMAND " | "
+.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health | trap | rate | lc | dpipe " } { " COMMAND " | "
.BR help " }"
.sp
@@ -28,7 +28,7 @@ utility and exit.
.TP
.BR "\-b", " \-batch " <FILENAME>
Read commands from provided file or standard input and invoke them.
-First failure will cause termination of devlink.
+The first failure will cause termination of devlink.
.TP
.B \-force
@@ -92,15 +92,27 @@ Print dump numbers in hexadecimal format.
.TP
.B region
-- devlink address region access
+- devlink address region access.
.TP
.B health
-- devlink reporting and recovery
+- devlink reporting and recovery.
.TP
.B trap
-- devlink trap configuration
+- devlink trap configuration.
+
+.TP
+.B rate
+- devlink rate object configuration.
+
+.TP
+.B lc
+- devlink line card configuration.
+
+.TP
+.B dpipe
+- devlink datapath pipeline visualization.
.SS
.I COMMAND
@@ -135,6 +147,9 @@ Exit status is 0 if command was successful or a positive integer upon failure.
.BR devlink-region (8),
.BR devlink-health (8),
.BR devlink-trap (8),
+.BR devlink-rate (8),
+.BR devlink-lc (8),
+.BR devlink-dpipe (8)
.br
.SH REPORTING BUGS
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 3/7] fix grammar and style issues in man pages for stat related pages
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 ` Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page Stephen Hemminger
` (4 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses grammatical errors and style inconsistencies in
the ifstat, lnstat, and rtacct man pages documentation.
lnstat Changes:
- Capitalize "Linux" as proper noun in NAME and DESCRIPTION sections
- Add missing period to -j/--json option description
- Fix passive voice: "is being used" -> "is used"
- Fix word form: "can not" -> "cannot"
rtacct Changes:
- Fix date format: remove comma in "27 June, 2007" -> "27 June 2007"
- Remove period from NAME section per man page convention
- Capitalize SNMP acronym (2 instances)
- Add missing periods to -h and -V option descriptions
- Improve clarity of -s/--noupdate description
- Add missing article in -d/--scan description
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/ifstat.8 | 4 ++--
man/man8/lnstat.8 | 10 +++++-----
man/man8/rtacct.8 | 16 ++++++++--------
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/man/man8/ifstat.8 b/man/man8/ifstat.8
index 8cd164dd..35389d57 100644
--- a/man/man8/ifstat.8
+++ b/man/man8/ifstat.8
@@ -28,7 +28,7 @@ Show version of program.
Ignore the history file.
.TP
.B \-d, \-\-scan=SECS
-Sample statistics every SECS second.
+Sample statistics every SECS seconds.
.TP
.B \-e, \-\-errors
Show errors.
@@ -67,7 +67,7 @@ Show extended stats of TYPE. Supported types are:
.SH ENVIRONMENT
.TP
.B IFSTAT_HISTORY
-If set, it's value is interpreted as alternate history file path.
+If set, its value is interpreted as alternate history file path.
.SH SEE ALSO
.BR ip (8)
.br
diff --git a/man/man8/lnstat.8 b/man/man8/lnstat.8
index b98241bf..9b548f19 100644
--- a/man/man8/lnstat.8
+++ b/man/man8/lnstat.8
@@ -1,6 +1,6 @@
.TH LNSTAT 8
.SH NAME
-lnstat \- unified linux network statistics
+lnstat \- unified Linux network statistics
.SH SYNOPSIS
.B lnstat
.RI [ options ]
@@ -13,7 +13,7 @@ command.
rtstat program. It is commonly used to periodically print a selection of
statistical values exported by the kernel.
In addition to routing cache statistics, it supports any kind of statistics the
-linux kernel exports via a file in /proc/net/stat/.
+Linux kernel exports via a file in /proc/net/stat/.
.PP
Each file in /proc/net/stat/ contains a header line listing the column names.
These names are used by \fBlnstat\fP as keys for selecting which statistics to
@@ -46,12 +46,12 @@ Statistics file to use, may be specified multiple times. By default all files in
Set interval to 'intv' seconds.
.TP
.B \-j, \-\-json
-Display results in JSON format
+Display results in JSON format.
.TP
.B \-k, \-\-keys k,k,k,...
Display only keys specified. Each key \fBk\fP is of the form \fB[file:]key\fP. If \fB<file>\fP
is given, the search for the given key is limited to that file. Otherwise the first file containing
-the searched key is being used.
+the searched key is used.
.TP
.B \-s, \-\-subject [0-2]
Specify display of subject/header. '0' means no header at all, '1' prints a header only at start of the program and '2' prints a header every 20 lines.
@@ -145,7 +145,7 @@ Number of \fBsearched\fP entries which were successful.
Number of conntrack entries added which were not expected before.
.sp
.B invalid
-Number of packets seen which can not be tracked.
+Number of packets seen which cannot be tracked.
.sp
.B ignore
Number of packets seen which are already connected to a conntrack entry.
diff --git a/man/man8/rtacct.8 b/man/man8/rtacct.8
index 988a6d1b..e3d9a1b7 100644
--- a/man/man8/rtacct.8
+++ b/man/man8/rtacct.8
@@ -1,7 +1,7 @@
-.TH RTACCT 8 "27 June, 2007"
+.TH RTACCT 8 "27 June 2007"
.SH NAME
-nstat, rtacct - network statistics tools.
+nstat, rtacct - network statistics tools
.SH SYNOPSIS
Usage: nstat [ -h?vVzrnasd:t:jp ] [ PATTERN [ PATTERN ] ]
@@ -12,10 +12,10 @@ Usage: rtacct [ -h?vVzrnasd:t: ] [ ListOfRealms ]
.B nstat
and
.B rtacct
-are simple tools to monitor kernel snmp counters and network interface statistics.
+are simple tools to monitor kernel SNMP counters and network interface statistics.
.B nstat
-can filter kernel snmp counters by name with one or several specified wildcards. Wildcards are case-insensitive and can include special symbols
+can filter kernel SNMP counters by name with one or several specified wildcards. Wildcards are case-insensitive and can include special symbols
.B ?
and
.B *
@@ -23,10 +23,10 @@ and
.SH OPTIONS
.B \-h, \-\-help
-Print help
+Print help.
.TP
.B \-V, \-\-version
-Print version
+Print version.
.TP
.B \-z, \-\-zeros
Dump zero counters too. By default they are not shown.
@@ -41,7 +41,7 @@ Do not display anything, only update history.
Dump absolute values of counters. The default is to calculate increments since the previous use.
.TP
.B \-s, \-\-noupdate
-Do not update history, so that the next time you will see counters including values accumulated to the moment of this measurement too.
+Do not update history, so that the next time you will see counters including values accumulated up to this measurement.
.TP
.B \-j, \-\-json
Display results in JSON format.
@@ -52,7 +52,7 @@ When combined with
pretty print the output.
.TP
.B \-d, \-\-scan <INTERVAL>
-Run in daemon mode collecting statistics. <INTERVAL> is interval between measurements in seconds.
+Run in daemon mode collecting statistics. <INTERVAL> is the interval between measurements in seconds.
.TP
.B \-t, \-\-interval <INTERVAL>
Time interval to average rates. Default value is 60 seconds.
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
` (2 preceding siblings ...)
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
2026-01-24 19:49 ` [PATCH iproute2-next 5/7] tipc: fix grammar and style issues in man pages Stephen Hemminger
` (3 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
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
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 5/7] tipc: fix grammar and style issues in man pages
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
` (3 preceding siblings ...)
2026-01-24 19:49 ` [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page Stephen Hemminger
@ 2026-01-24 19:49 ` Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 6/7] vdpa: fix grammar, titles, and formatting " Stephen Hemminger
` (2 subsequent siblings)
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses grammatical errors, typos, and formatting issues
across the TIPC man page documentation.
Changes by file:
tipc.8:
- Fix subject-verb agreement: "consists" -> "consist"
tipc-bearer.8:
- Fix verb agreement: "udp identify" -> "udp identifies"
- Fix article and hyphenation: "an multi bearer" -> "a multi-bearer"
- Fix IP notation: "IP v4/v6" -> "IPv4/IPv6"
tipc-link.8:
- Fix plural verb: "messages has been" -> "messages have been"
- Fix preposition: "If set of 0" -> "If set to 0"
- Fix plural noun: "Possible status are" -> "Possible statuses are"
(3 instances)
tipc-nametable.8:
- Fix misplaced help text: move from after -p option to -h option
where it belongs
tipc-node.8:
- Fix preposition: "On the form" -> "In the form"
- Fix typo: "Can by used" -> "Can be used"
tipc-socket.8:
- Add missing comma in SEE ALSO section after tipc-bearer(8)
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/tipc-bearer.8 | 6 +++---
man/man8/tipc-link.8 | 10 +++++-----
man/man8/tipc-nametable.8 | 11 +++++------
man/man8/tipc-node.8 | 4 ++--
man/man8/tipc-socket.8 | 2 +-
man/man8/tipc.8 | 2 +-
6 files changed, 17 insertions(+), 18 deletions(-)
diff --git a/man/man8/tipc-bearer.8 b/man/man8/tipc-bearer.8
index d95b1e1c..4011d6d1 100644
--- a/man/man8/tipc-bearer.8
+++ b/man/man8/tipc-bearer.8
@@ -112,7 +112,7 @@ identify a bearer with a
.I DEVICE
while
.B udp
-identify a bearer with a
+identifies a bearer with a
.IR "LOCALIP " "and a " NAME
.B ib
@@ -155,7 +155,7 @@ link establish requests.
Default link priority inherited by all links subsequently established over a
bearer. A single bearer can only host one link to a particular node. This means
the default link priority for a bearer typically affects which bearer to use
-when communicating with a particular node in an multi bearer setup. For more
+when communicating with a particular node in a multi-bearer setup. For more
info about link priority see
.BR tipc-link (8)
@@ -178,7 +178,7 @@ bearer. For more info about the link window size see
.TP
.BI "localip " LOCALIP
.br
-Specify a local IP v4/v6 address for a
+Specify a local IPv4/IPv6 address for a
.B udp
bearer.
diff --git a/man/man8/tipc-link.8 b/man/man8/tipc-link.8
index 47dae25d..ac6c7a2b 100644
--- a/man/man8/tipc-link.8
+++ b/man/man8/tipc-link.8
@@ -158,7 +158,7 @@ Subsequently the
.B fragments
are the total amount of packets that the
.B fragmented
-messages has been broken into.
+messages have been broken into.
.TP
.B Bundles
@@ -262,7 +262,7 @@ activated.
.br
The threshold specifies the cluster size exceeding which the link monitoring
algorithm will switch from "full-mesh" to "overlapping-ring".
-If set of 0 the overlapping-ring monitoring is always on and if set to a
+If set to 0 the overlapping-ring monitoring is always on and if set to a
value larger than anticipated cluster size the overlapping-ring is disabled.
The default value is 32.
@@ -290,7 +290,7 @@ Possible values are full-mesh or overlapping-ring.
.B status
.br
The node status derived by the local node.
-Possible status are up or down.
+Possible statuses are up or down.
.TP
.B monitored
@@ -313,7 +313,7 @@ of a domain record to know if it should ignore or process the record.
The node status reported by the peer node for the succeeding peers in
the node list. The Node list is a circular list of ascending addresses
starting with the local node.
-Possible status are: U or D. The status U implies up and D down.
+Possible statuses are: U or D. The status U implies up and D down.
.TP
.B [non_applied_node:status]
@@ -322,7 +322,7 @@ Represents the nodes and their status as reported by the peer node.
These nodes were not applied to the monitoring list for this peer node.
They are usually transient and occur during the cluster startup phase
or network reconfiguration.
-Possible status are: U or D. The status U implies up and D down.
+Possible statuses are: U or D. The status U implies up and D down.
.SS Broadcast properties
.TP
diff --git a/man/man8/tipc-nametable.8 b/man/man8/tipc-nametable.8
index f7c51f19..a8d357ab 100644
--- a/man/man8/tipc-nametable.8
+++ b/man/man8/tipc-nametable.8
@@ -18,6 +18,11 @@ tipc-nametable \- show TIPC nametable
Options (flags) that can be passed anywhere in the command chain.
.TP
.BR "\-h" , " --help"
+Show help about last valid command. For example
+.B tipc nametable --help
+will show nametable help and
+.B tipc --help
+will show general help. The position of the option in the string is irrelevant.
.TP
.BR "\-j", " \-json"
@@ -28,12 +33,6 @@ Output results in JavaScript Object Notation (JSON).
The default JSON format is compact and more efficient to parse but hard for most users to read.
This flag adds indentation for readability.
-Show help about last valid command. For example
-.B tipc nametable --help
-will show nametable help and
-.B tipc --help
-will show general help. The position of the option in the string is irrelevant.
-
.SH DESCRIPTION
The nametable shows TIPC publication information.
diff --git a/man/man8/tipc-node.8 b/man/man8/tipc-node.8
index a72a4099..4a199c47 100644
--- a/man/man8/tipc-node.8
+++ b/man/man8/tipc-node.8
@@ -41,13 +41,13 @@ will show general help. The position of the option in the string is irrelevant.
.TP
.BI address
.br
-The TIPC logical address. On the form x.y.z where x, y and z are unsigned
+The TIPC logical address. In the form x.y.z where x, y and z are unsigned
integers.
.TP
.BI netid
.br
-Network identity. Can by used to create individual TIPC clusters on the same
+Network identity. Can be used to create individual TIPC clusters on the same
media.
.SH EXIT STATUS
diff --git a/man/man8/tipc-socket.8 b/man/man8/tipc-socket.8
index 23ec1e51..5b04d866 100644
--- a/man/man8/tipc-socket.8
+++ b/man/man8/tipc-socket.8
@@ -43,7 +43,7 @@ Exit status is 0 if command was successful or a positive integer upon failure.
.SH SEE ALSO
.BR tipc (8),
-.BR tipc-bearer (8)
+.BR tipc-bearer (8),
.BR tipc-link (8),
.BR tipc-media (8),
.BR tipc-nametable (8),
diff --git a/man/man8/tipc.8 b/man/man8/tipc.8
index 6706cca1..95904989 100644
--- a/man/man8/tipc.8
+++ b/man/man8/tipc.8
@@ -78,7 +78,7 @@ This flag adds indentation for readability.
.SH ARGUMENTS
Command arguments are described in a command specific man page and typically
-consists of nested commands along with key value pairs.
+consist of nested commands along with key value pairs.
If no arguments are given a command typically shows its help text. The explicit
help option
.B -h
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 6/7] vdpa: fix grammar, titles, and formatting in man pages
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
` (4 preceding siblings ...)
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 ` 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
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses grammatical errors, copy-paste errors from devlink
documentation, and formatting issues across the vdpa man page documentation.
Changes by file:
vdpa.8:
- Remove unnecessary article: "a pretty JSON output" -> "pretty JSON output"
vdpa-dev.8:
- Fix incorrect title: "DEVLINK\-DEV" -> "VDPA\-DEV"
- Fix file path: "virtio*h" -> "virtio*.h" (add missing period)
- Fix capitalization and punctuation in macro description
- Split overly long vstats section header into title + body
- Fix spacing: "-Name" -> "- Name"
- Fix article error: "the all vdpa devices" -> "all vdpa devices"
- Add missing periods to example descriptions (2 instances)
vdpa-mgmtdev.8:
- Fix incorrect title: "DEVLINK\-DEV" -> "VDPA\-MGMTDEV"
- Fix NAME section: "vdpa-dev" -> "vdpa-mgmtdev"
The title corrections in vdpa-dev.8 and vdpa-mgmtdev.8 fix critical
copy-paste errors that would cause man page indexing problems and
confusion about which command is being documented.
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/vdpa-dev.8 | 18 ++++++++++--------
man/man8/vdpa-mgmtdev.8 | 4 ++--
man/man8/vdpa.8 | 2 +-
3 files changed, 13 insertions(+), 11 deletions(-)
diff --git a/man/man8/vdpa-dev.8 b/man/man8/vdpa-dev.8
index 718f40b2..4e2522f0 100644
--- a/man/man8/vdpa-dev.8
+++ b/man/man8/vdpa-dev.8
@@ -1,4 +1,4 @@
-.TH DEVLINK\-DEV 8 "5 Jan 2021" "iproute2" "Linux"
+.TH VDPA\-DEV 8 "5 Jan 2021" "iproute2" "Linux"
.SH NAME
vdpa-dev \- vdpa device configuration
.SH SYNOPSIS
@@ -84,9 +84,9 @@ Name of the management device to use for device addition.
.BI device_features " DEVICE_FEATURES"
Specifies the virtio device features bit-mask that is provisioned for the new vdpa device.
-The bits can be found under include/uapi/linux/virtio*h.
+The bits can be found under include/uapi/linux/virtio*.h.
-see macros such as VIRTIO_F_ and VIRTIO_XXX(e.g NET)_F_ for specific bit values.
+See macros such as VIRTIO_F_ and VIRTIO_XXX (e.g., NET)_F_ for specific bit values.
This is optional.
@@ -116,7 +116,9 @@ Format is:
.in +2
VDPA_DEVICE_NAME
-.SS vdpa dev vstats show - shows vendor specific statistics for the given device and virtqueue index. The information is presented as name-value pairs where name is the name of the field and value is a numeric value for it.
+.SS vdpa dev vstats show - show vendor specific statistics
+
+Shows vendor specific statistics for the given device and virtqueue index. The information is presented as name-value pairs where name is the name of the field and value is a numeric value for it.
.TP
.BI "DEV"
@@ -129,7 +131,7 @@ VDPA_DEVICE_NAME
.SS vdpa dev set - set the configuration to the vdpa device.
.BI name " NAME"
--Name of the vdpa device to configure.
+- Name of the vdpa device to configure.
.BI mac " MACADDR"
- specifies the mac address for the vdpa device.
@@ -139,7 +141,7 @@ This is applicable only for the network type of vdpa device.
.PP
vdpa dev show
.RS 4
-Shows the all vdpa devices on the system.
+Shows all vdpa devices on the system.
.RE
.PP
vdpa dev show foo
@@ -154,7 +156,7 @@ Add the vdpa device named foo on the management device vdpa_sim_net.
.PP
vdpa dev add name foo mgmtdev vdpa_sim_net device_features 0x300020000
.RS 4
-Add the vdpa device named foo on the management device vdpa_sim_net with device_features of 0x300020000
+Add the vdpa device named foo on the management device vdpa_sim_net with device_features of 0x300020000.
.RE
.PP
vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55
@@ -169,7 +171,7 @@ Add the vdpa device named foo on the management device vdpa_sim_net with mac add
.PP
vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8
.RS 4
-Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs
+Add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs.
.RE
.PP
vdpa dev del foo
diff --git a/man/man8/vdpa-mgmtdev.8 b/man/man8/vdpa-mgmtdev.8
index cae2cbd0..9a7529fc 100644
--- a/man/man8/vdpa-mgmtdev.8
+++ b/man/man8/vdpa-mgmtdev.8
@@ -1,6 +1,6 @@
-.TH DEVLINK\-DEV 8 "5 Jan 2021" "iproute2" "Linux"
+.TH VDPA\-MGMTDEV 8 "5 Jan 2021" "iproute2" "Linux"
.SH NAME
-vdpa-dev \- vdpa management device view
+vdpa-mgmtdev \- vdpa management device view
.SH SYNOPSIS
.sp
.ad l
diff --git a/man/man8/vdpa.8 b/man/man8/vdpa.8
index d1aaecec..81725312 100644
--- a/man/man8/vdpa.8
+++ b/man/man8/vdpa.8
@@ -25,7 +25,7 @@ Generate JSON output.
.TP
.BR "\-p" , " --pretty"
-When combined with -j generate a pretty JSON output.
+When combined with -j generate pretty JSON output.
.SS
.I OBJECT
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH iproute2-next 7/7] rdma: fix grammar, formatting, and style in man pages
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
` (5 preceding siblings ...)
2026-01-24 19:49 ` [PATCH iproute2-next 6/7] vdpa: fix grammar, titles, and formatting " Stephen Hemminger
@ 2026-01-24 19:49 ` Stephen Hemminger
2026-01-31 19:20 ` [PATCH iproute2-next 0/7] man page corrections patchwork-bot+netdevbpf
7 siblings, 0 replies; 9+ messages in thread
From: Stephen Hemminger @ 2026-01-24 19:49 UTC (permalink / raw)
To: netdev; +Cc: Stephen Hemminger
This patch addresses grammatical errors, overly long section headers,
missing punctuation, and style inconsistencies across all RDMA man
page documentation.
Changes by file:
rdma.8:
- Fix hyphenation: "non zero" -> "non-zero"
- Remove article: "a pretty JSON" -> "pretty JSON"
- Capitalize option description: "output" -> "Output"
- Add missing period after "monitor"
rdma-dev.8:
- Split overly long section headers into concise titles + body text
- Fix semicolon to period and add missing articles
- Fix possessive: "it's parent" -> "its parent"
- Add missing article: "specified" -> "the specified"
- Fix tense: "is previously created" -> "was previously created"
- Add article: "iproute2 ip command" -> "the iproute2 ip command"
- Fix verb tense in examples: "Add" -> "Adds", "Delete" -> "Deletes"
rdma-link.8:
- Split overly long section header
- Add missing article: "specified" -> "the specified"
- Add missing periods (2 instances)
rdma-monitor.8:
- Split awkward section header and reword
- Add missing period
rdma-resource.8:
- Add missing article: "specified" -> "the specified"
- Add missing periods (4 instances)
rdma-statistic.8:
- Split overly long section header
- Fix verb form: "are bind" -> "are bound"
- Add missing periods (7 instances)
- Fix grammar: "does not exists" -> "it does not exist"
- Fix plural verb: "that was enabled" -> "that were enabled"
rdma-system.8:
- Fix plural: "network namespace" -> "network namespaces"
- Remove duplicate .PP line
The most significant improvements are splitting overly long section
headers across multiple files, fixing missing punctuation in examples,
and correcting various grammatical errors.
No functional changes. All technical content remains accurate.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
man/man8/rdma-dev.8 | 23 ++++++++++++++---------
man/man8/rdma-link.8 | 10 ++++++----
man/man8/rdma-monitor.8 | 7 +++++--
man/man8/rdma-resource.8 | 6 +++---
man/man8/rdma-statistic.8 | 24 +++++++++++++-----------
man/man8/rdma-system.8 | 3 +--
man/man8/rdma.8 | 8 ++++----
7 files changed, 46 insertions(+), 35 deletions(-)
diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
index e26f738c..abc9f405 100644
--- a/man/man8/rdma-dev.8
+++ b/man/man8/rdma-dev.8
@@ -65,17 +65,22 @@ rdma-dev \- RDMA device configuration
- specifies the RDMA device to show.
If this argument is omitted all devices are listed.
-.SS rdma dev add - Add a RDMA device with a specific type and parent IB device; This new device provides subset of functionalities defined in IBTA spec.
-.SS rdma dev delete - Delete a RDMA device which is created with the "add" command.
+.SS rdma dev add - add a RDMA device
+
+Add a RDMA device with a specific type and parent IB device. This new device provides a subset of functionalities defined in the IBTA spec.
+
+.SS rdma dev delete - delete a RDMA device
+
+Delete a RDMA device which was created with the "add" command.
.I NAME
- The name of the device being added/deleted.
.I TYPE
-- The type of the device being added; It specifies which functionalities it provides. Supported device type:
+- The type of the device being added. It specifies which functionalities it provides. Supported device type:
.sp
.in +8
.B SMI
-- A device with this type provides SMI (QP0) interface. This device and it's parent associates with the same HCA port and shares the physical link, so when the parent doesn't support SMI, then this type of device can be created to allow the subnet manager to configure the link.
+- A device with this type provides SMI (QP0) interface. This device and its parent associates with the same HCA port and shares the physical link, so when the parent doesn't support SMI, then this type of device can be created to allow the subnet manager to configure the link.
.in -8
.I PARENT_DEV
@@ -90,7 +95,7 @@ Shows the state of all RDMA devices on the system.
.PP
rdma dev show mlx5_3
.RS 4
-Shows the state of specified RDMA device.
+Shows the state of the specified RDMA device.
.RE
.PP
rdma dev set mlx5_3 name rdma_0
@@ -100,8 +105,8 @@ Renames the mlx5_3 device to rdma_0.
.PP
rdma dev set mlx5_3 netns foo
.RS 4
-Changes the network namespace of RDMA device to foo where foo is
-previously created using iproute2 ip command.
+Changes the network namespace of RDMA device to foo where foo was
+previously created using the iproute2 ip command.
.RE
.PP
rdma dev set mlx5_3 adaptive-moderation [on/off]
@@ -114,12 +119,12 @@ This is a global setting for the RDMA device but the value is printed for each C
.PP
rdma dev add smi1 type SMI parent ibp8s0f1
.RS 4
-Add a new IB device with name "smi1", type "SMI", and "ibp8s0f1" as its parent device.
+Adds a new IB device with name "smi1", type "SMI", and "ibp8s0f1" as its parent device.
.RE
.PP
rdma dev delete smi1
.RS 4
-Delete the IB device "smi1".
+Deletes the IB device "smi1".
.RE
.PP
diff --git a/man/man8/rdma-link.8 b/man/man8/rdma-link.8
index 5e4a5307..7a4be457 100644
--- a/man/man8/rdma-link.8
+++ b/man/man8/rdma-link.8
@@ -45,7 +45,9 @@ rdma-link \- rdma link configuration
- specifies the RDMA link to show.
If this argument is omitted all links are listed.
-.SS rdma link add NAME type TYPE netdev NETDEV - add an rdma link for the specified type to the network device
+.SS rdma link add - add an rdma link
+
+Add an rdma link for the specified type to the network device.
.sp
.BR NAME
- specifies the new name of the rdma link to add
@@ -79,17 +81,17 @@ Shows the state of all rdma links on the system.
.PP
rdma link show mlx5_2/1
.RS 4
-Shows the state of specified rdma link.
+Shows the state of the specified rdma link.
.RE
.PP
rdma link add rxe_eth0 type rxe netdev eth0
.RS 4
-Adds a RXE link named rxe_eth0 to network device eth0
+Adds a RXE link named rxe_eth0 to network device eth0.
.RE
.PP
rdma link del rxe_eth0
.RS 4
-Removes RXE link rxe_eth0
+Removes RXE link rxe_eth0.
.RE
.PP
diff --git a/man/man8/rdma-monitor.8 b/man/man8/rdma-monitor.8
index d445cba0..5e82e092 100644
--- a/man/man8/rdma-monitor.8
+++ b/man/man8/rdma-monitor.8
@@ -23,7 +23,10 @@ rdma-monitor \- RDMA events monitoring
.B rdma monitor help
.SH "DESCRIPTION"
-.SS rdma monitor - utility can monitor RDMA device events on all RDMA devices.
+.SS rdma monitor - monitor RDMA device events
+
+This utility can monitor RDMA device events on all RDMA devices.
+
.PP
.B rdma
opens an RDMA Netlink socket, listens on it and dumps the event info.
@@ -35,7 +38,7 @@ and net device attachment/detachment.
.PP
rdma monitor
.RS 4
-Listen for events of all RDMA devices
+Listen for events of all RDMA devices.
.RE
.PP
diff --git a/man/man8/rdma-resource.8 b/man/man8/rdma-resource.8
index 1035478d..61bec471 100644
--- a/man/man8/rdma-resource.8
+++ b/man/man8/rdma-resource.8
@@ -45,7 +45,7 @@ Shows summary for all devices on the system.
.PP
rdma resource show mlx5_2
.RS 4
-Shows the state of specified rdma device.
+Shows the state of the specified rdma device.
.RE
.PP
rdma res show qp link mlx5_4
@@ -95,12 +95,12 @@ Show CM_IDs with destination ip port of 7174.
.PP
rdma resource show cm_id src-addr 172.16.0.100
.RS 4
-Show CM_IDs bound to local ip address 172.16.0.100
+Show CM_IDs bound to local ip address 172.16.0.100.
.RE
.PP
rdma resource show cq pid 30489
.RS 4
-Show CQs belonging to pid 30489
+Show CQs belonging to pid 30489.
.RE
.PP
rdma resource show ctx ctxn 1
diff --git a/man/man8/rdma-statistic.8 b/man/man8/rdma-statistic.8
index 337e31ef..c81e3b75 100644
--- a/man/man8/rdma-statistic.8
+++ b/man/man8/rdma-statistic.8
@@ -98,7 +98,9 @@ rdma-statistic \- RDMA statistic counter configuration
.RB "{ " cntn " | " lqpn " | " pid " | " qp-type " }"
.SH "DESCRIPTION"
-.SS rdma statistic [object] show - Queries the specified RDMA device for RDMA and driver-specific statistics. Show the default hw counters if object is not specified
+.SS rdma statistic [object] show - display RDMA statistics
+
+Queries the specified RDMA device for RDMA and driver-specific statistics. Shows the default hw counters if object is not specified.
.PP
.I "DEV"
@@ -111,7 +113,7 @@ rdma-statistic \- RDMA statistic counter configuration
- specifies a filter to show only the results matching it.
.SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
-In auto mode all objects belong to one category are bind automatically to a single counter set. The "off" is global for all auto modes together. Not applicable for MR's.
+In auto mode all objects belong to one category are bound automatically to a single counter set. The "off" is global for all auto modes together. Not applicable for MR's.
.SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
When bound the statistics of this object are available in this counter. Not applicable for MR's.
@@ -143,7 +145,7 @@ Shows the state of the default counter of all RDMA devices on the system.
.PP
rdma statistic show link mlx5_2/1
.RS 4
-Shows the state of the default counter of specified RDMA port
+Shows the state of the default counter of specified RDMA port.
.RE
.PP
rdma statistic qp show
@@ -158,22 +160,22 @@ Shows the state of all qp counters of specified RDMA port.
.PP
rdma statistic qp show link mlx5_2 pid 30489
.RS 4
-Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
+Shows the state of all qp counters of specified RDMA port and belonging to pid 30489.
.RE
.PP
rdma statistic qp show link mlx5_2 qp-type UD
.RS 4
-Shows the state of all qp counters of specified RDMA port and with QP type UD
+Shows the state of all qp counters of specified RDMA port and with QP type UD.
.RE
.PP
rdma statistic qp mode
.RS 4
-List current counter mode on all devices
+List current counter mode on all devices.
.RE
.PP
rdma statistic qp mode link mlx5_2/1
.RS 4
-List current counter mode of device mlx5_2 port 1
+List current counter mode of device mlx5_2 port 1.
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto type on
@@ -203,12 +205,12 @@ Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manual
.PP
rdma statistic qp bind link mlx5_2/1 lqpn 178
.RS 4
-On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
+On device mlx5_2 port 1, allocate a counter and bind the specified qp on it.
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
.RS 4
-On device mlx5_2 port 1, bind the specified qp on the specified counter
+On device mlx5_2 port 1, bind the specified qp on the specified counter.
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 4
@@ -223,12 +225,12 @@ List all currently allocated MR's and their counters.
.PP
rdma statistic show mr mrn 6
.RS 4
-Dump a specific MR statistics with mrn 6. Dumps nothing if does not exists.
+Dump a specific MR statistics with mrn 6. Dumps nothing if it does not exist.
.RE
.PP
rdma statistic mode link mlx5_2/1
.RS 4
-Display the optional counters that was enabled on mlx5_2/1.
+Display the optional counters that were enabled on mlx5_2/1.
.RE
.PP
rdma statistic mode supported link mlx5_2/1
diff --git a/man/man8/rdma-system.8 b/man/man8/rdma-system.8
index 5373027a..8aff9d38 100644
--- a/man/man8/rdma-system.8
+++ b/man/man8/rdma-system.8
@@ -51,7 +51,7 @@ one or more RDMA devices exist, changing mode from shared to
exclusive returns error code EBUSY.
When RDMA subsystem is in shared mode, RDMA device is accessible in
-all network namespace. When RDMA device isolation among multiple
+all network namespaces. When RDMA device isolation among multiple
network namespaces is not needed, shared mode can be used.
It is preferred to not change the subsystem mode when there is active
@@ -82,7 +82,6 @@ Sets the RDMA subsystem in network namespace shared mode. In this mode RDMA devi
are shared among network namespaces.
.RE
.PP
-.PP
rdma system set privileged-qkey on
.RS 4
Sets the privileged-qkey parameter to on. In this state non-privileged user
diff --git a/man/man8/rdma.8 b/man/man8/rdma.8
index df86284d..4061b9ae 100644
--- a/man/man8/rdma.8
+++ b/man/man8/rdma.8
@@ -46,7 +46,7 @@ First failure will cause termination of rdma.
.TP
.BR "\-force"
Don't terminate rdma on errors in batch mode.
-If there were any errors during execution of the commands, the application return code will be non zero.
+If there were any errors during execution of the commands, the application return code will be non-zero.
.TP
.BR "\-d" , " --details"
@@ -58,7 +58,7 @@ Output includes driver-specific details in raw format.
.TP
.BR "\-p" , " --pretty"
-When combined with -j generate a pretty JSON output.
+When combined with -j generate pretty JSON output.
.TP
.BR "\-j" , " --json"
@@ -66,7 +66,7 @@ Generate JSON output.
.TP
.BR "\-o" , " \-oneline"
-output each record on a single line, replacing line feeds
+Output each record on a single line, replacing line feeds
with the
.B '\e'
character.
@@ -96,7 +96,7 @@ character.
.TP
.B monitor
-- RDMA events monitor
+- RDMA events monitor.
.PP
The names of all objects may be written in full or
--
2.51.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* Re: [PATCH iproute2-next 0/7] man page corrections
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
` (6 preceding siblings ...)
2026-01-24 19:49 ` [PATCH iproute2-next 7/7] rdma: fix grammar, formatting, and style " Stephen Hemminger
@ 2026-01-31 19:20 ` patchwork-bot+netdevbpf
7 siblings, 0 replies; 9+ messages in thread
From: patchwork-bot+netdevbpf @ 2026-01-31 19:20 UTC (permalink / raw)
To: Stephen Hemminger; +Cc: netdev
Hello:
This series was applied to iproute2/iproute2-next.git (main)
by David Ahern <dsahern@kernel.org>:
On Sat, 24 Jan 2026 11:49:24 -0800 you wrote:
> AI does a great job of finding and fixing manual pages.
> This patch series is the result of editorial review and correction of
> subsystem man pages, addressing grammatical errors, style inconsistencies, and
> clarity issues throughout the documentation.
>
> The corrections cover the following subsystems:
> - DCB (Data Center Bridging)
> - devlink
> - Statistics tools (lnstat, rtacct, nstat)
> - netshaper
> - TIPC
> - vdpa
> - RDMA
>
> [...]
Here is the summary with links:
- [iproute2-next,1/7] dcb: fix grammar and style issues in man pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=9be6919137c5
- [iproute2-next,2/7] devlink: fix grammar and style issues in man pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=aea0ff56598c
- [iproute2-next,3/7] fix grammar and style issues in man pages for stat related pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=7bfb82531d36
- [iproute2-next,4/7] netshaper: fix grammar and style issues in man page
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=8a966d9025ed
- [iproute2-next,5/7] tipc: fix grammar and style issues in man pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=df638236f887
- [iproute2-next,6/7] vdpa: fix grammar, titles, and formatting in man pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=4706396c3179
- [iproute2-next,7/7] rdma: fix grammar, formatting, and style in man pages
https://git.kernel.org/pub/scm/network/iproute2/iproute2-next.git/commit/?id=4d4e73273a45
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 9+ messages in thread