dcb-app.8: some remarks and editorial changes for this manual
From: Bjarni Ingi Gislason <hidden>
Date: 2024-11-03 17:14:46
Subsystem:
the rest · Maintainer:
Linus Torvalds
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_manual" should be in an attachment. -.- Signed-off-by: Bjarni Ingi Gislason <redacted>
diff --git a/dcb-app.8 b/dcb-app.8.new
index be505a0..dde3d28 100644
--- a/dcb-app.8
+++ b/dcb-app.8.new@@ -3,20 +3,19 @@ dcb-app \- show / manipulate application priority table of the DCB (Data Center Bridging) subsystem .SH SYNOPSIS -.sp .ad l .in +8 .ti -8 .B dcb -.RI "[ " OPTIONS " ] " +.RI "[ " OPTIONS " ]" .B app .RI "{ " COMMAND " | " help " }" .sp .ti -8 .B dcb app " { " show " | " flush " } " dev -.RI DEV +.I DEV .RB "[ " default-prio " ]" .RB "[ " ethtype-prio " ]" .RB "[ " stream-port-prio " ]"
@@ -27,7 +26,7 @@ the DCB (Data Center Bridging) subsystem .ti -8 .B dcb app " { " add " | " del " | " replace " } " dev -.RI DEV +.I DEV .RB "[ " default-prio " " \fIPRIO-LIST\fB " ]" .RB "[ " ethtype-prio " " \fIET-MAP\fB " ]" .RB "[ " stream-port-prio " " \fIPORT-MAP\fB " ]"
@@ -90,7 +89,7 @@ other prioritization rule applies. DCB APP entries are 3-tuples of selector, protocol ID, and priority. Selector is an enumeration that picks one of the prioritization namespaces. Currently it mostly corresponds to configurable parameters described below. Protocol ID is a -value in the selector namespace. E.g. for EtherType selector, protocol IDs are +value in the selector namespace. E.g., for EtherType selector, protocol IDs are the individual EtherTypes, for DSCP they are individual code points. The priority is the priority that should be assigned to traffic that matches the selector and protocol ID.
@@ -108,7 +107,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 prioritization is in effect for a given selector and protocol ID.
@@ -190,7 +189,7 @@ will only use the higher six bits). .B dcb app 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
@@ -199,8 +198,8 @@ turns the show translation off. .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 +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 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.
@@ -220,7 +219,7 @@ Add another rule to configure DSCP 24 to priority 2 and show the result: .br dscp-prio 0:0 CS3:2 CS3:3 CS6:6 .br -# dcb -N app show dev eth0 dscp-prio +# dcb \-N app show dev eth0 dscp-prio .br dscp-prio 0:0 24:2 24:3 48:6
@@ -230,7 +229,7 @@ priority 4: .P # dcb app replace dev eth0 dscp-prio 24:4 .br -# dcb app -N show dev eth0 dscp-prio +# dcb app \-N show dev eth0 dscp-prio .br dscp-prio 0:0 24:4 48:6
Attachments
- chk_man.err.dcb-app.8 [text/plain] 7575 bytes · preview