dcb-pfc.8: some remarks and editorial changes for this manual

dcb-pfc.8: some remarks and editorial changes for this manual

[Bjarni Ingi Gislason]

[-- Attachment #1: Type: text/plain, Size: 3751 bytes --]

  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>


diff --git a/dcb-pfc.8 b/dcb-pfc.8.new
index 735c16e..01fdb34 100644
--- a/dcb-pfc.8
+++ b/dcb-pfc.8.new
@@ -3,20 +3,19 @@
 dcb-pfc \- show / manipulate PFC (Priority-based Flow Control) settings of
 the DCB (Data Center Bridging) subsystem
 .SH SYNOPSIS
-.sp
 .ad l
 .in +8
 
 .ti -8
 .B dcb
-.RI "[ " OPTIONS " ] "
+.RI "[ " OPTIONS " ]"
 .B pfc
 .RI "{ " COMMAND " | " help " }"
 .sp
 
 .ti -8
 .B dcb pfc show dev
-.RI DEV
+.I DEV
 .RB "[ " pfc-cap " ]"
 .RB "[ " prio-pfc " ]"
 .RB "[ " macsec-bypass " ]"
@@ -26,7 +25,7 @@ the DCB (Data Center Bridging) subsystem
 
 .ti -8
 .B dcb pfc set dev
-.RI DEV
+.I DEV
 .RB "[ " prio-pfc " " \fIPFC-MAP " ]"
 .RB "[ " macsec-bypass " { " on " | " off " } ]"
 .RB "[ " delay " " \fIINTEGER\fR " ]"
@@ -35,7 +34,7 @@ the DCB (Data Center Bridging) subsystem
 .IR PFC-MAP " := [ " PFC-MAP " ] " PFC-MAPPING
 
 .ti -8
-.IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fR "{ "
+.IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fR {
 .IR \fBon\fR " | " \fBoff\fR " }"
 
 .ti -8
@@ -45,17 +44,22 @@ the DCB (Data Center Bridging) subsystem
 
 .B dcb pfc
 is used to configure Priority-based Flow Control attributes through Linux
-DCB (Data Center Bridging) interface. PFC permits marking flows with a
-certain priority as lossless, and holds related configuration, as well as
-PFC counters.
+DCB (Data Center Bridging) interface.
+PFC permits marking flows with a certain priority as lossless,
+and holds related configuration,
+as well as PFC counters.
 
 .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 PFC configuration.
+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 PFC configuration.
 
 .TP
 .B pfc-cap
@@ -64,13 +68,13 @@ simultaneously support PFC.
 
 .TP
 .B requests
-A read-only count of the sent PFC frames per traffic class. Only shown when
--s is given, or when requested explicitly.
+A read-only count of the sent PFC frames per traffic class.
+Only shown when \-s is given, or when requested explicitly.
 
 .TP
 .B indications
-A read-only count of the received PFC frames per traffic class. Only shown
-when -s is given, or when requested explicitly.
+A read-only count of the received PFC frames per traffic class.
+Only shown when \-s is given, or when requested explicitly.
 
 .TP
 .B macsec-bypass \fR{ \fBon\fR | \fBoff\fR }
@@ -81,8 +85,10 @@ MACsec is disabled.
 .B prio-pfc \fIPFC-MAP
 \fIPFC-MAP\fR uses the array parameter syntax, see
 .BR dcb (8)
-for details. Keys are priorities, values are on / off indicators of whether
-PFC is enabled for a given priority.
+for details.
+Keys are priorities,
+values are on / off indicators of whether PFC is enabled for a given
+priority.
 
 .TP
 .B delay \fIINTEGER

[-- Attachment #2: chk_man.err.dcb-pfc.8 --]
[-- Type: text/plain, Size: 4533 bytes --]

  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-pfc.8": (possibly shortened list)

mandoc: dcb-pfc.8:6:2: WARNING: skipping paragraph macro: sp after SH

-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.

19:.RI DEV
29:.RI DEV

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

68:-s is given, or when requested explicitly.
73:when -s is given, or when requested explicitly.

-.-.

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.

55: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.

48:DCB (Data Center Bridging) interface. PFC permits marking flows with a
55:i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the
56:parameter name is to be used as a simple keyword without further arguments. This
57:instructs the tool to show the value of a given parameter. When no parameters
67:A read-only count of the sent PFC frames per traffic class. Only shown when
72:A read-only count of the received PFC frames per traffic class. Only shown
84:for details. Keys are priorities, values are on / off indicators of whether

-.-.

No space is needed before a quote (") at the end of a line

12:.RI "[ " OPTIONS " ] "
38:.IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\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>':38
troff:<stdin>:38: warning: trailing space in the line

Re: dcb-pfc.8: some remarks and editorial changes for this manual

[Stephen Hemminger]

On Wed, 6 Nov 2024 01:05:09 +0000
Bjarni Ingi Gislason <bjarniig@simnet.is> wrote:

>   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>

Is the last of the dcb man changes?

Re: dcb-pfc.8: some remarks and editorial changes for this manual

[Bjarni Ingi Gislason]

On Wed, Nov 06, 2024 at 09:10:46AM -0800, Stephen Hemminger wrote:
> On Wed, 6 Nov 2024 01:05:09 +0000
> Bjarni Ingi Gislason <bjarniig@simnet.is> wrote:
> 
> >   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>
> 
> Is the last of the dcb man changes?

The last but one (already submitted).

"devlink-*' are also marked, but that will wait until other man pages in
other packages have been dealt with.