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

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

Powered by blists - more mailing lists