netdev - dcb-dcbx.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: <Zyp0DxgipVa8KZSN@kassi.invalid.is>
Date: Tue, 5 Nov 2024 19:37:51 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-dcbx.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-dcbx.8 b/dcb-dcbx.8.new
index bafc18f..790c56c 100644
--- a/dcb-dcbx.8
+++ b/dcb-dcbx.8.new
@@ -2,24 +2,23 @@
 .SH NAME
 dcb-dcbx \- show / manipulate port DCBX (Data Center Bridging eXchange)
 .SH SYNOPSIS
-.sp
 .ad l
 .in +8
 
 .ti -8
 .B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
 .B dcbx
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb dcbx show dev
-.RI DEV
+.I DEV
 
 .ti -8
 .B dcb dcbx set dev
-.RI DEV
+.I DEV
 .RB "[ " host " ]"
 .RB "[ " lld-managed " ]"
 .RB "[ " cee " ]"
@@ -29,16 +28,20 @@ dcb-dcbx \- show / manipulate port DCBX (Data Center Bridging eXchange)
 .SH DESCRIPTION
 
 Data Center Bridging eXchange (DCBX) is a protocol used by DCB devices to
-exchange configuration information with directly connected peers. The Linux DCBX
-object is a 1-byte bitfield of flags that configure whether DCBX is implemented
-in the device or in the host, and which version of the protocol should be used.
+exchange configuration information with directly connected peers.
+The Linux DCBX object is a 1-byte bitfield of flags that configure whether
+DCBX is implemented in the device or in the host,
+and which version of the protocol should be used.
 .B dcb dcbx
 is used to access the per-port Linux DCBX object.
 
 There are two principal modes of operation: in
 .B host
-mode, DCBX protocol is implemented by the host LLDP agent, and the DCB
-interfaces are used to propagate the negotiate parameters to capable devices. In
+mode,
+DCBX protocol is implemented by the host LLDP agent,
+and the DCB interfaces are used to propagate the negotiate parameters to
+capable devices.
+In
 .B lld-managed
 mode, the configuration is handled by the device, and DCB interfaces are used
 for inspection of negotiated parameters, and can also be used to set initial
@@ -47,19 +50,21 @@ parameters.
 .SH PARAMETERS
 
 When used with
-.B dcb dcbx set,
-the following keywords enable the corresponding configuration. The keywords that
-are not mentioned on the command line are considered disabled. When used with
-.B show,
+.BR "dcb dcbx set" ,
+the following keywords enable the corresponding configuration.
+The keywords that are not mentioned on the command line are considered
+disabled.
+When used with
+.BR show ,
 each enabled feature is shown by its corresponding keyword.
 
 .TP
 .B host
 .TQ
 .B lld-managed
-The device is in the host mode of operation and, respectively, the lld-managed
-mode of operation, as described above. In principle these two keywords are
-mutually exclusive, but
+The device is in the host mode of operation and, respectively,
+the lld-managed mode of operation, as described above.
+In principle these two keywords are mutually exclusive, but
 .B dcb dcbx
 allows setting both and lets the driver handle it as appropriate.
 
@@ -67,15 +72,17 @@ allows setting both and lets the driver handle it as appropriate.
 .B cee
 .TQ
 .B ieee
-The device supports CEE (Converged Enhanced Ethernet) and, respectively, IEEE
-version of the DCB specification. Typically only one of these will be set, but
+The device supports CEE (Converged Enhanced Ethernet) and, respectively,
+IEEE version of the DCB specification.
+Typically only one of these will be set, but
 .B dcb dcbx
 does not mandate this.
 
 .TP
 .B static
-indicates the engine supports static configuration. No actual negotiation is
-performed, negotiated parameters are always the initial configuration.
+indicates the engine supports static configuration.
+No actual negotiation is performed,
+negotiated parameters are always the initial configuration.
 
 .SH EXAMPLE & USAGE
 

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