[<prev] [next>] [day] [month] [year] [list]
Message-ID: <ZyrJKT2g5m2jf5el@kassi.invalid.is>
Date: Wed, 6 Nov 2024 01:40:57 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-rewr.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-rewr.8 b/dcb-rewr.8.new
index 03b59cf..c4c338f 100644
--- a/dcb-rewr.8
+++ b/dcb-rewr.8.new
@@ -3,26 +3,25 @@
dcb-rewr \- show / manipulate the rewrite table of
the DCB (Data Center Bridging) subsystem
.SH SYNOPSIS
-.sp
.ad l
.in +8
.ti -8
.B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
.B rewr
.RI "{ " COMMAND " | " help " }"
.sp
.ti -8
.B dcb rewr " { " show " | " flush " } " dev
-.RI DEV
+.I DEV
.RB "[ " prio-dscp " ]"
.RB "[ " prio-pcp " ]"
.ti -8
.B dcb rewr " { " add " | " del " | " replace " } " dev
-.RI DEV
+.I DEV
.RB "[ " prio-dscp " " \fIDSCP-MAP\fB " ]"
.RB "[ " prio-pcp " " \fIPCP-MAP\fB " ]"
@@ -30,13 +29,13 @@ the DCB (Data Center Bridging) subsystem
.IR DSCP-MAP " := [ " DSCP-MAP " ] " DSCP-MAPPING
.ti -8
-.IR DSCP-MAPPING " := " \fIPRIO \fB:\fR "{ " DSCP " | " \fBall\fR " }"
+.IR DSCP-MAPPING " := " "PRIO\fB:\fR" "{ " DSCP " | " \fBall\fR " }"
.ti -8
.IR PCP-MAP " := [ " PCP-MAP " ] " PCP-MAPPING
.ti -8
-.IR PCP-MAPPING " := " \fIPRIO \fB:\fR PCP\fR
+.IR PCP-MAPPING " := " PRIO \fB:\fR PCP
.ti -8
.IR DSCP " := { " \fB0\fR " .. " \fB63\fR " }"
@@ -73,7 +72,7 @@ and
.B del
commands. On the other hand, the command
.B replace
-does what one would typically want in this situation--first adds the new
+does what one would typically want in this situation\(emfirst adds the new
configuration, and then removes the obsolete one, so that only one
rewrite rule is in effect for a given selector and priority.
@@ -126,7 +125,7 @@ will only use the higher six bits).
.B dcb rewr show
will similarly format DSCP values as symbolic names if possible. The
command line option
-.B -N
+.B \-N
turns the show translation off.
.TP
@@ -135,8 +134,8 @@ turns the show translation off.
.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
+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
combination 1:2de translates to a mapping of priority 1 to PCP=2 and DEI=1.
@@ -155,7 +154,7 @@ Add a rule to rewrite DSCP to 25 for traffic with priority 3:
.br
prio-dscp 0:0 3:CS3 3:25 6:CS6
.br
-# dcb -N rewr show dev eth0 prio-dscp
+# dcb \-N rewr show dev eth0 prio-dscp
.br
prio-dscp 0:0 3:24 3:25 6:48
@@ -165,7 +164,7 @@ priority 3.
.P
# dcb rewr replace dev eth0 prio-dscp 3:26
.br
-# dcb rewr -N show dev eth0 prio-dscp
+# dcb rewr \-N show dev eth0 prio-dscp
.br
prio-dscp 0:0 3:26 6:48
View attachment "chk_man.err.dcb-rewr.8" of type "text/plain" (5538 bytes)
Powered by blists - more mailing lists