netdev - dcb-maxrate.8: some remarks and editorial changes for this manual

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <ZyqfTZWejPMsFQWz@kassi.invalid.is>
Date: Tue, 5 Nov 2024 22:42:21 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-maxrate.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-maxrate.8 b/dcb-maxrate.8.new
index d03c215..cc415ef 100644
--- a/dcb-maxrate.8
+++ b/dcb-maxrate.8.new
@@ -3,25 +3,24 @@
 dcb-maxrate \- show / manipulate port maxrate settings of
 the DCB (Data Center Bridging) subsystem
 .SH SYNOPSIS
-.sp
 .ad l
 .in +8
 
 .ti -8
 .B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
 .B maxrate
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb maxrate show dev
-.RI DEV
+.I DEV
 .RB "[ " tc-maxrate " ]"
 
 .ti -8
 .B dcb maxrate set dev
-.RI DEV
+.I DEV
 .RB "[ " tc-maxrate " " \fIRATE-MAP " ]"
 
 .ti -8
@@ -34,7 +33,7 @@ the DCB (Data Center Bridging) subsystem
 .IR TC " := { " \fB0\fR " .. " \fB7\fR " }"
 
 .ti -8
-.IR RATE " := { " INTEGER "[" \fBbit\fR "] | " INTEGER\fBKbit\fR " | "
+.IR RATE " := { " INTEGER "[" \fBbit\fR "] | " INTEGER\fBKbit\fR " |"
 .IR INTEGER\fBMib\fR " | " ... " }"
 
 .SH DESCRIPTION
@@ -45,7 +44,7 @@ egress from a given traffic class.
 
 .SH PARAMETERS
 
-The following describes only the write direction, i.e. as used with the
+The following describes only the write direction, 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
@@ -60,13 +59,13 @@ The rates can use the notation documented in section PARAMETERS at
 .BR tc (8).
 Note that under that notation, "bit" stands for bits per second whereas "b"
 stands for bytes per second. When showing, the command line option
-.B -i
+.B \-i
 toggles between using decadic and ISO/IEC prefixes.
 
 .SH EXAMPLE & USAGE
 
-Set rates of all traffic classes to 25Gbps, except for TC 6, which will
-have the rate of 100Gbps:
+Set rates of all traffic classes to 25\~Gbit/s, except for TC 6,
+which will have the rate of 100\~Gbit/s:
 
 .P
 # dcb maxrate set dev eth0 tc-maxrate all:25Gbit 6:100Gbit
@@ -76,7 +75,8 @@ Show what was set:
 .P
 # dcb maxrate show dev eth0
 .br
-tc-maxrate 0:25Gbit 1:25Gbit 2:25Gbit 3:25Gbit 4:25Gbit 5:25Gbit 6:100Gbit 7:25Gbit
+tc-maxrate 0:25Gbit 1:25Gbit 2:25Gbit 3:25Gbit 4:25Gbit 5:25Gbit 6:100Gbit \
+7:25Gbit
 
 .SH EXIT STATUS
 Exit status is 0 if command was successful or a positive integer upon failure.

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