Message-ID: <ZypN2Fv_tBCT_AY2@kassi.invalid.is>
Date: Tue, 5 Nov 2024 16:54:48 +0000
From: Bjarni Ingi Gislason <bjarniig@...net.is>
To: netdev@...r.kernel.org
Subject: dcb-buffer.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>



--- dcb-buffer.8	2024-11-05 00:32:12.449059896 +0000
+++ dcb-buffer.8.new	2024-11-05 01:01:52.385065995 +0000
@@ -3,27 +3,26 @@
 dcb-buffer \- show / manipulate port buffer settings of
 the DCB (Data Center Bridging) subsystem
 .SH SYNOPSIS
-.sp
 .ad l
 .in +8
 
 .ti -8
 .B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
 .B buffer
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb buffer show dev
-.RI DEV
+.I DEV
 .RB "[ " prio-buffer " ]"
 .RB "[ " buffer-size " ]"
 .RB "[ " total-size " ]"
 
 .ti -8
 .B dcb buffer set dev
-.RI DEV
+.I DEV
 .RB "[ " prio-buffer " " \fIPRIO-MAP " ]"
 .RB "[ " buffer-size " " \fISIZE-MAP " ]"
 
@@ -46,35 +45,43 @@ the DCB (Data Center Bridging) subsystem
 .IR BUFFER " := { " \fB0\fR " .. " \fB7\fR " }"
 
 .ti -8
-.IR SIZE " := { " INTEGER " | " INTEGER\fBK\fR " | " INTEGER\fBM\fR " | " ... " }"
+.IR SIZE " := { " INTEGER " | " INTEGER\fBK\fR " | " INTEGER\fBM\fR " | " \
+\&... " }"
 
 .SH DESCRIPTION
 
 .B dcb buffer
 is used to configure assignment of traffic to port buffers based on traffic
-priority, and sizes of those buffers. It can be also used to inspect the current
-configuration, as well as total device memory that the port buffers take.
+priority, and sizes of those buffers.
+It can be also used to inspect the current configuration,
+as well as total device memory that the port buffers take.
 
 .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
-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 buffer configuration.
+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 buffer configuration.
 
 .TP
 .B total-size
 A read-only property that shows the total device memory taken up by port
-buffers. This might be more than a simple sum of individual buffer sizes if
+buffers.
+This might be more than a simple sum of individual buffer sizes if
 there are any hidden or internal buffers.
 
 .TP
 .B prio-buffer \fIPRIO-MAP
 \fIPRIO-MAP\fR uses the array parameter syntax, see
 .BR dcb (8)
-for details. Keys are priorities, values are buffer indices. For each priority
-sets a buffer where traffic with that priority is directed to.
+for details.
+Keys are priorities, values are buffer indices.
+For each priority sets a buffer where traffic with that priority is directed
+to.
 
 .TP
 .B buffer-size \fISIZE-MAP
@@ -93,8 +100,8 @@ Configure the priomap in a one-to-one fa
 .P
 # dcb buffer set dev eth0 prio-buffer 0:0 1:1 2:2 3:3 4:4 5:5 6:6 7:7
 
-Set sizes of all buffers to 10KB, except for buffer 6, which will have the size
-1MB:
+Set sizes of all buffers to 10\~kibibytes (KiB),
+except for buffer 6, which will have the size 1\~mebibyte (MiB):
 
 .P
 # dcb buffer set dev eth0 buffer-size all:10K 6:1M

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

Powered by blists - more mailing lists