Message-ID: <ZylcVAmsr55YK38b@kassi.invalid.is>
Date: Mon, 4 Nov 2024 23:44:20 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-apptrust.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_manual" is in the attachment.

-.-

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


--- dcb-apptrust.8	2024-11-04 19:51:38.581034458 +0000
+++ dcb-apptrust.8.new	2024-11-04 20:04:44.751223062 +0000
@@ -3,33 +3,33 @@
 dcb-apptrust \- show / configure per-selector trust and trust order of the
 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 apptrust
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb apptrust show dev
-.RI DEV
+.I DEV
 .RB "[ " order " ]"
 
 .ti -8
 .B dcb apptrust set dev
-.RI DEV
-.RB "[ " order "
+.I DEV
+.RB "[ " order
 .IR "SEL-LIST" " ]"
 
 .ti -8
 .IR SEL-LIST " := [ " SEL-LIST " ] " SEL
 
 .ti -8
-.IR SEL " := { " ethtype " | " stream-port " | " dgram-port " | " port " | " dscp " | " pcp " } "
+.IR SEL " := { " ethtype " | " stream-port " | " dgram-port " | " port " | " \
+dscp " | " pcp " }"
 
 .SH DESCRIPTION
 
@@ -40,10 +40,13 @@ Application Priority Table, see
 for details on how to configure app table entries.
 
 Selector trust can be used by the
-software stack, or drivers (most likely the latter), when querying the APP
-table, to determine if an APP entry should take effect, or not. Additionally, the
-order of the trusted selectors will dictate which selector should take
-precedence, in the case of multiple different APP table selectors being present.
+software stack, or drivers (most likely the latter),
+when querying the APP table,
+to determine if an APP entry should take effect, or not.
+Additionally,
+the order of the trusted selectors will dictate which selector should take
+precedence,
+in the case of multiple different APP table selectors being present.
 
 .SH COMMANDS
 
@@ -53,25 +56,27 @@ Display all trusted selectors.
 
 .TP
 .B set
-Set new list of trusted selectors. Empty list is effectively the same as
-removing trust entirely.
+Set new list of trusted selectors.
+Empty list is effectively the same as removing trust entirely.
 
 .SH PARAMETERS
 
-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 values of a given parameter.
+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 values of a given parameter.
 
 .TP
 .B order \fISEL-LIST
-\fISEL-LIST\fR is a space-separated list of selector names. Possible selector
-values are:
-.B ethtype,
-.B stream-port,
-.B dgram-port,
-.B port,
-.B dscp,
+\fISEL-LIST\fR is a space-separated list of selector names.
+Possible selector values are:
+.BR ethtype ,
+.BR stream-port ,
+.BR dgram-port ,
+.BR port ,
+.BR dscp ,
 and
 .B pcp
 

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

Powered by blists - more mailing lists