@@ -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:
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@simnet.is> Any program (person), that produces man pages, should check the output for defects by using (both groff and nroff) [gn]roff -mandoc -t -ww -b -z -K utf8 <man page> The same goes for man pages that are used as an input. For a style guide use mandoc -T lint -.- So any 'generator' should check its products with the above mentioned 'groff', 'mandoc', and additionally with 'nroff ...'. This is just a simple quality control measure. The 'generator' may have to be corrected to get a better man page, the source file may, and any additional file may. Common defects: Input text line longer than 80 bytes. Not removing trailing spaces (in in- and output). The reason for these trailing spaces should be found and eliminated. Not beginning each input sentence on a new line. Lines should thus be shorter. See man-pages(7), item 'semantic newline'. -.- The difference between the formatted output of the original and patched file can be seen with: nroff -mandoc <file1> > <out1> nroff -mandoc <file2> > <out2> diff -u <out1> <out2> and for groff, using "printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - " instead of 'nroff -mandoc' Add the option '-t', if the file contains a table. Read the output of 'diff -u' with 'less -R' or similar. -.-. If 'man' (man-db) is used to check the manual for warnings, the following must be set: The option "-warnings=w" The environmental variable: export MAN_KEEP_STDERR=yes (or any non-empty value) or (produce only warnings): export MANROFFOPT="-ww -b -z" export MAN_KEEP_STDERR=yes (or any non-empty value) -.-. Output from "mandoc -T lint dcb-ets.8": (possibly shortened list) mandoc: dcb-ets.8:6:2: WARNING: skipping paragraph macro: sp after SH mandoc: dcb-ets.8:147:2: WARNING: skipping paragraph macro: br before sp mandoc: dcb-ets.8:167:2: WARNING: skipping paragraph macro: br before text line with leading blank -.-. Use the correct macro for the font change of a single argument or split the argument into two. 19:.RI DEV 33:.RI DEV -.-. Add a comma (or \&) after "e.g." and "i.e.", or use English words (man-pages(7)). Abbreviation points should be protected against being interpreted as an end of sentence, if they are not, and that independent of the current place on the line. 80:i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the -.-. Wrong distance between sentences in the input file. Separate the sentences and subordinate clauses; each begins on a new line. See man-pages(7) ("Conventions for source file layout") and "info groff" ("Input Conventions"). The best procedure is to always start a new sentence on a new line, at least, if you are typing on a computer. Remember coding: Only one command ("sentence") on each (logical) line. E-mail: Easier to quote exactly the relevant lines. Generally: Easier to edit the sentence. Patches: Less unaffected text. Search for two adjacent words is easier, when they belong to the same line, and the same phrase. The amount of space between sentences in the output can then be controlled with the ".ss" request. 68:DCB (Data Center Bridging) interface. ETS permits configuration of mapping of 73:values. Recommendation values are named with a prefix 80:i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the 81:parameter name is to be used as a simple keyword without further arguments. This 82:instructs the tool to show the value of a given parameter. When no parameters 104:for details. Keys are priorities, values are traffic classes. For each priority 113:for details. Keys are TCs, values are Transmission Selection Algorithm (TSA) 114:keywords described below. For each TC sets an algorithm used for deciding how 115:traffic queued up at this TC is scheduled for transmission. Supported TSAs are: 142:for details. Keys are TCs, values are integers representing percent of available 143:bandwidth given to the traffic class in question. The value should be 0 for TCs 144:whose TSA is not \fBets\fR, and the sum of all values shall be 100. As an -.-. Use \(en (en-dash) for a dash between space characters, not a minus (\-) or a hyphen (-), except in the NAME section. dcb-ets.8:118:- for strict priority, where traffic in higher-numbered TCs always takes dcb-ets.8:122:- for Enhanced Traffic Selection, where available bandwidth is distributed among dcb-ets.8:130:- for Credit Based Shaper, where traffic is scheduled in a strict manner up to dcb-ets.8:134:- for vendor-specific traffic selection algorithm. -.-. Split a punctuation from a single argument, if a two-font macro is meant 74:.B reco-, 126:.B reco-tc-bw\fR, -.-. No space is needed before a quote (") at the end of a line 12:.RI "[ " OPTIONS " ] " 43:.IR TSA-MAPPING " := { " TC " | " \fBall " }" \fB: "{ " \fBstrict\fR " | " -.-. Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ": troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':709: macro 'RI' troff: backtrace: file '<stdin>':12 troff:<stdin>:12: warning: trailing space in the line troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':679: macro 'IR' troff: backtrace: file '<stdin>':43 troff:<stdin>:43: warning: trailing space in the line -.- Additional changes: Add empty lines between "TSA-MAP" cases.