Message-ID: <ZyqOI3MK0ROapWU3@kassi.invalid.is>
Date: Tue, 5 Nov 2024 21:29:07 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-ets.8: some remarks and editorial changes for this manual

  The man page is from Debian:

Package: iproute2
Version: 6.11.0-1
Severity: minor
Tags: patch

  Improve the layout of the man page according to the "man-page(7)"
guidelines, the output of "mandoc -lint T", the output of
"groff -mandoc -t -ww -b -z", that of a shell script, and typographical
conventions.

-.-

  Output from a script "chk_man" is in the attachment.

-.-

Signed-off-by: Bjarni Ingi Gislason <bjarniig@...net.is>



diff --git a/dcb-ets.8 b/dcb-ets.8.new
index 9c64b33..b90d2ca 100644
--- a/dcb-ets.8
+++ b/dcb-ets.8.new
@@ -3,20 +3,19 @@
 dcb-ets \- show / manipulate ETS (Enhanced Transmission Selection) settings of
 the DCB (Data Center Bridging) subsystem
 .SH SYNOPSIS
-.sp
 .ad l
 .in +8
 
 .ti -8
 .B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
 .B ets
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb ets show dev
-.RI DEV
+.I DEV
 .RB "[ " willing " ]"
 .RB "[ " ets-cap " ]"
 .RB "[ " cbs " ]"
@@ -30,7 +29,7 @@ the DCB (Data Center Bridging) subsystem
 
 .ti -8
 .B dcb ets set dev
-.RI DEV
+.I DEV
 .RB "[ " willing " { " on " | " off " } ]"
 .RB "[ { " tc-tsa " | " reco-tc-tsa " } " \fITSA-MAP\fB " ]"
 .RB "[ { " pg-bw " | " tc-bw " | " reco-tc-bw " } " \fIBW-MAP\fB " ]"
@@ -40,7 +39,7 @@ the DCB (Data Center Bridging) subsystem
 .IR TSA-MAP " := [ " TSA-MAP " ] " TSA-MAPPING
 
 .ti -8
-.IR TSA-MAPPING " := { " TC " | " \fBall " }" \fB: "{ " \fBstrict\fR " | "
+.IR TSA-MAPPING " := { " TC " | " \fBall " }" \fB: "{ " \fBstrict\fR " |"
 .IR \fBcbs\fR " | " \fBets\fR " | " \fBvendor\fR " }"
 
 .ti -8
@@ -71,13 +70,13 @@ class, bandwidth allocation, etc.
 
 Two DCB TLVs are related to the ETS feature: a configuration and recommendation
 values. Recommendation values are named with a prefix
-.B reco-,
+.BR reco- ,
 while the configuration ones have plain names.
 
 .SH PARAMETERS
 
 For read-write parameters, the following describes only the write direction,
-i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the
+i.e., as used with the \fBset\fR command. For the \fBshow\fR command, the
 parameter name is to be used as a simple keyword without further arguments. This
 instructs the tool to show the value of a given parameter. When no parameters
 are given, the tool shows the complete ETS configuration.
@@ -115,23 +114,23 @@ 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
-- for strict priority, where traffic in higher-numbered TCs always takes
+\(en for strict priority, where traffic in higher-numbered TCs always takes
 precedence over traffic in lower-numbered TCs.
-.br
+.sp 1v
 .B ets
-- for Enhanced Traffic Selection, where available bandwidth is distributed among
+\(en for Enhanced Traffic Selection, where available bandwidth is distributed among
 the ETS-enabled TCs according to the weights set by
 .B tc-bw
 and
-.B reco-tc-bw\fR,
+.BR reco-tc-bw ,
 respectively.
-.br
+.sp 1v
 .B cbs
-- for Credit Based Shaper, where traffic is scheduled in a strict manner up to
+\(en for Credit Based Shaper, where traffic is scheduled in a strict manner up to
 the limit set by a shaper.
-.br
+.sp 1v
 .B vendor
-- for vendor-specific traffic selection algorithm.
+\(en for vendor-specific traffic selection algorithm.
 
 .TP
 .B tc-bw \fIBW-MAP
@@ -144,7 +143,6 @@ bandwidth given to the traffic class in question. The value should be 0 for TCs
 whose TSA is not \fBets\fR, and the sum of all values shall be 100. As an
 exception to the standard wording, a configuration with no \fBets\fR TCs is
 permitted to sum up to 0 instead.
-.br
 
 .TP
 .B pg-bw \fIBW-MAP
@@ -164,7 +162,6 @@ Set TSA and transmit bandwidth configuration:
 
 .P
 # dcb ets set dev eth0 tc-tsa all:strict 0:ets 1:ets 2:ets \\
-.br
                        tc-bw all:0 0:33 1:33 2:34
 
 Show what was set:

View attachment "chk_man.err.dcb-ets.8" of type "text/plain" (5332 bytes)

Powered by blists - more mailing lists