Package: net-tools
Version: 2.10-1.1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
troff: backtrace: file '<stdin>':92
troff:<stdin>:92: warning: trailing space in the line
troff: backtrace: file '<stdin>':93
troff:<stdin>:93: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.11.5-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages net-tools depends on:
ii libc6 2.40-3
ii libselinux1 3.7-3
net-tools recommends no packages.
net-tools suggests no packages.
-- no debconf information
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 mii-tool.8": (possibly shortened list)
mandoc: mii-tool.8:84:82: STYLE: input text line longer than 80 bytes: If the
interface is ...
mandoc: mii-tool.8:92:54: STYLE: whitespace at end of input line
mandoc: mii-tool.8:93:86: STYLE: input text line longer than 80 bytes: The
interface in que...
mandoc: mii-tool.8:93:86: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
92:SIOCGMIIPHY on 'eth?' failed: Operation not supported
93:The interface in question does not support MII queries. Most likely, it does
not have
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
19:.RI "interface\ ..."
-.-.
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.
47:registers, including non standard ones. It's not guaranteed any
93:The interface in question does not support MII queries. Most likely, it does
not have
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 3, length 81
.TH MII\-TOOL 8 "2013\-02\-15" "net\-tools" "Linux System Administrator's
Manual"
Line 84, length 82
If the interface is not running (up), kernel will refuse to report its link
state.
Line 93, length 86
The interface in question does not support MII queries. Most likely, it does
not have
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':92
troff:<stdin>:92: warning: trailing space in the line
troff: backtrace: file '<stdin>':93
troff:<stdin>:93: warning: trailing space in the line
--- mii-tool.8 2024-11-12 01:12:18.099672233 +0000
+++ mii-tool.8.new 2024-11-12 01:29:08.062030449 +0000
@@ -1,6 +1,7 @@
.\" Copyright (C) 2000 David A. Hinds -- [email protected]
.\"
-.TH MII\-TOOL 8 "2013\-02\-15" "net\-tools" "Linux System Administrator's
Manual"
+.TH MII\-TOOL 8 "2013\-02\-15" "net\-tools" "Linux System Administrator's \
+Manual"
.SH NAME
mii\-tool \- view, manipulate media-independent interface status
@@ -16,7 +17,7 @@ mii\-tool \- view, manipulate media-inde
[\fB\-A\fR, \fB\-\-advertise=\fImedia,...\fR]
[\fB\-F\fR, \fB\-\-force=\fImedia\fR]
[\fB\-p\fR, \fB\-\-phy=\fIaddr\fR]
-.RI "interface\ ..."
+.IR interface \ ...
.SH DESCRIPTION
This utility checks or sets the status of a network interface's Media
@@ -43,9 +44,11 @@ status for each interface.
Display more detailed MII status information. If used twice, also
display raw MII register contents.
.br
-\fBAlert:\fR If used three times, will force reading all MII
-registers, including non standard ones. It's not guaranteed any
-valid answer from PHY while PHY communication can even hang.
+\fBAlert:\fR If used three times,
+will force reading all MII registers,
+including non standard ones.
+It's not guaranteed any valid answer from PHY
+while PHY communication can even hang.
With driver e1000e will fail while reading register 0x07.
.TP
\fB\-V\fR, \fB\-\-version\fR
@@ -81,7 +84,8 @@ Override the MII address provided by ker
.SH DIAGNOSTICS
.TP
SIOCGMIIPHY on 'eth?' failed: Invalid argument
-If the interface is not running (up), kernel will refuse to report its link
state.
+If the interface is not running (up),
+kernel will refuse to report its link state.
.TP
SIOCGMIIPHY on 'eth?' failed: Operation not permitted
Most kernels restrict access to root.
@@ -89,9 +93,9 @@ Most kernels restrict access to root.
SIOCGMIIPHY on 'eth?' failed: No such device
This error is shown, if the kernel does not know about the named device.
.TP
-SIOCGMIIPHY on 'eth?' failed: Operation not supported
-The interface in question does not support MII queries. Most likely, it does
not have
-MII transceivers, at all.
+SIOCGMIIPHY on 'eth?\&' failed: Operation not supported
+The interface in question does not support MII queries.
+Most likely, it does not have MII transceivers, at all.
.SH AUTHORS
David Hinds \- [email protected]
