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

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

Powered by blists - more mailing lists