dcb: fix grammar and style issues in man pages

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>
Signed-off-by: David Ahern <dsahern@kernel.org>

diff --git a/man/man8/dcb-app.8 b/man/man8/dcb-app.8
index be505a0be3087eecf60d23109f2084d72c004c5d..dea36a2f58b6aa090e50a3ef861953a8658e4ebc 100644 (file)
--- 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 ddc2133fa2567e7fd1adc06ee7872239bb096ff4..77ac0a4ae970c2096c62caed14de96ca3efb0e32 100644 (file)
--- 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 c7ba6a993ee60408bd5ed00fd2040a80ea991780..4d9e6f409652867992183ac7702ef53c3b9f5465 100644 (file)
--- 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 bafc18f6e05c6d6e44e295c20b4cdeb74cd68d7e..b06617adac3170fb7d29484f669c7dfb220178b8 100644 (file)
--- 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 9c64b33e30ffdb01d7b0ab9e14f23b12836787ad..9373d640b167bdb24c825fce3bf6c1cb67360541 100644 (file)
--- 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 03b59cf4837ce789f0f27954f6a8082b32d9a915..a2ee704c576efd4d170e9ebf27d8c0fc631bcb2a 100644 (file)
--- 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 a1d6505e93b426a27ce543efd0689e8f0532b380..f04fa7b79c544bddd1deff9c54ab9848d6379fb5 100644 (file)
--- 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),