Package: binutils-common
Version: 2.44-3
Severity: minor
Tags: upstream
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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?
an.tmac:<stdin>:68: style: 3 leading space(s) on input line
[...]
an.tmac:<stdin>:126: style: use of deprecated macro: .PD
[...]
troff:<stdin>:411: 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.12.17-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)
-- no debconf information
Input file is nm.1
Output from "mandoc -T lint nm.1": (shortened list)
1 empty block: RS
1 input text line longer than 80 bytes: Print both value and...
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z nm.1": (shortened list)
1 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if Pod::Man generated this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
nm.1:604:Copyright (c) 1991\-2025 Free Software Foundation, Inc.
-.-.
Reduce space between words.
nm.1:520:\&\fBnm\fR use the linker plugin it must be copied into the
-.-.
Use ".nf" and ".fi" to end it, for an extra indention.
nm.1:68: [\fB\-a\fR|\fB\-\-debug\-syms\fR]
nm.1:69: [\fB\-B\fR|\fB\-\-format=bsd\fR]
nm.1:70: [\fB\-C\fR|\fB\-\-demangle\fR[=\fIstyle\fR]]
nm.1:71: [\fB\-D\fR|\fB\-\-dynamic\fR]
nm.1:72: [\fB\-f\fR\fIformat\fR|\fB\-\-format=\fR\fIformat\fR]
nm.1:73: [\fB\-g\fR|\fB\-\-extern\-only\fR]
nm.1:74: [\fB\-h\fR|\fB\-\-help\fR]
nm.1:75: [\fB\-\-ifunc\-chars=\fR\fICHARS\fR]
nm.1:76: [\fB\-j\fR|\fB\-\-format=just\-symbols\fR]
nm.1:77: [\fB\-l\fR|\fB\-\-line\-numbers\fR] [\fB\-\-inlines\fR]
nm.1:78: [\fB\-n\fR|\fB\-v\fR|\fB\-\-numeric\-sort\fR]
nm.1:79: [\fB\-P\fR|\fB\-\-portability\fR]
nm.1:80: [\fB\-p\fR|\fB\-\-no\-sort\fR]
nm.1:81: [\fB\-r\fR|\fB\-\-reverse\-sort\fR]
nm.1:82: [\fB\-S\fR|\fB\-\-print\-size\fR]
nm.1:83: [\fB\-s\fR|\fB\-\-print\-armap\fR]
nm.1:84: [\fB\-t\fR \fIradix\fR|\fB\-\-radix=\fR\fIradix\fR]
nm.1:85: [\fB\-u\fR|\fB\-\-undefined\-only\fR]
nm.1:86: [\fB\-U\fR|\fB\-\-defined\-only\fR]
nm.1:87: [\fB\-V\fR|\fB\-\-version\fR]
nm.1:88: [\fB\-W\fR|\fB\-\-no\-weak\fR]
nm.1:89: [\fB\-X 32_64\fR]
nm.1:90: [\fB\-\-no\-demangle\fR]
nm.1:91: [\fB\-\-no\-recurse\-limit\fR|\fB\-\-recurse\-limit\fR]]
nm.1:92: [\fB\-\-plugin\fR \fIname\fR]
nm.1:93: [\fB\-\-size\-sort\fR]
nm.1:94: [\fB\-\-special\-syms\fR]
nm.1:95: [\fB\-\-synthetic\fR]
nm.1:96: [\fB\-\-target=\fR\fIbfdname\fR]
nm.1:97: [\fB\-\-unicode=\fR\fImethod\fR]
nm.1:98: [\fB\-\-with\-symbol\-versions\fR]
nm.1:99: [\fB\-\-without\-symbol\-versions\fR]
nm.1:100: [\fIobjfile\fR...]
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address)
549 .IP \fB\-\-unicode=\fR\fI[default|invalid|locale|escape|hex|highlight]\fR 4
-.-.
Wrong distance (not two spaces) 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.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
325:makes C++ function names readable. Different compilers have different
326:mangling styles. The optional demangling style argument can be used to
390:the user to specify a string containing one or two characters. The
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 368, length 124
\&\f(CW\*(C`sysv\*(C'\fR, \f(CW\*(C`posix\*(C'\fR or
\f(CW\*(C`just\-symbols\*(C'\fR. The default is \f(CW\*(C`bsd\*(C'\fR.
Line 414, length 88
\&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and
address is from
Line 415, length 108
\&\f(CW\*(C`callee2\*(C'\fR, the source information for
\f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR
Line 457, length 88
Print both value and size of defined symbols for the \f(CW\*(C`bsd\*(C'\fR
output style.
Line 601, length 96
\&\fBar\fR\|(1), \fBobjdump\fR\|(1), \fBranlib\fR\|(1), and the Info entries
for \fIbinutils\fR.
Longest line is number 368 with 124 characters
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
72: [\fB\-f\fR\fIformat\fR|\fB\-\-format=\fR\fIformat\fR]
75: [\fB\-\-ifunc\-chars=\fR\fICHARS\fR]
84: [\fB\-t\fR \fIradix\fR|\fB\-\-radix=\fR\fIradix\fR]
96: [\fB\-\-target=\fR\fIbfdname\fR]
97: [\fB\-\-unicode=\fR\fImethod\fR]
320:.IP \fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR 4
364:.IP \fB\-\-format=\fR\fIformat\fR 4
385:.IP \fB\-\-ifunc\-chars=\fR\fICHARS\fR 4
473:.IP \fB\-\-radix=\fR\fIradix\fR 4
549:.IP \fB\-\-unicode=\fR\fI[default|invalid|locale|escape|hex|highlight]\fR 4
583:.IP \fB\-\-target=\fR\fIbfdname\fR 4
586:.IP \fB@\fR\fIfile\fR 4
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
nm.1:109:The symbol value, in the radix selected by options (see below), or
nm.1:116:symbols (\f(CW\*(C`u\*(C'\fR, \f(CW\*(C`v\*(C'\fR and
\f(CW\*(C`w\*(C'\fR).
nm.1:303:Precede each symbol by the name of the input file (or archive member)
nm.1:316:The same as \fB\-\-format=bsd\fR (for compatibility with the MIPS
\fBnm\fR).
nm.1:449:Reverse the order of the sort (whether numeric or alphabetic); let the
nm.1:484:Display only undefined symbols (those external to each object file).
-.-.
Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).
nm.1:325:makes C++ function names readable. Different compilers have different
nm.1:326:mangling styles. The optional demangling style argument can be used to
nm.1:390:the user to specify a string containing one or two characters. The
-.-.
Put a subordinate sentence (after a comma) on a new line.
[List of affected lines removed.]
-.-
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
61:.if n .ad l
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
11:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
599:.SH "SEE ALSO"
-.-.
.\" Define a fallback for font CW with
.if t \{\
. ie \n(.g .ds fC \f(CR
. el .ds fC \f(CW
. ds fP \fP
.\}
.
.if n \{\
. ds fC \fR
. ds fP \fP
.\}
116:symbols (\f(CW\*(C`u\*(C'\fR, \f(CW\*(C`v\*(C'\fR and \f(CW\*(C`w\*(C'\fR).
119:.el .IP \f(CWA\fR 4
124:.el .IP \f(CWB\fR 4
128:.el .IP \f(CWb\fR 4
135:.el .IP \f(CWC\fR 4
139:.el .IP \f(CWc\fR 4
149:.el .IP \f(CWD\fR 4
153:.el .IP \f(CWd\fR 4
158:.el .IP \f(CWG\fR 4
162:.el .IP \f(CWg\fR 4
169:.el .IP \f(CWi\fR 4
188:.el .IP \f(CWI\fR 4
192:.el .IP \f(CWN\fR 4
196:.el .IP \f(CWn\fR 4
200:.el .IP \f(CWp\fR 4
204:.el .IP \f(CWR\fR 4
208:.el .IP \f(CWr\fR 4
213:.el .IP \f(CWS\fR 4
217:.el .IP \f(CWs\fR 4
223:.el .IP \f(CWT\fR 4
227:.el .IP \f(CWt\fR 4
232:.el .IP \f(CWU\fR 4
236:.el .IP \f(CWu\fR 4
243:.el .IP \f(CWV\fR 4
247:.el .IP \f(CWv\fR 4
256:.el .IP \f(CWW\fR 4
260:.el .IP \f(CWw\fR 4
271:.el .IP \f(CW\-\fR 4
277:.el .IP \f(CW?\fR 4
367:Use the output format \fIformat\fR, which can be \f(CW\*(C`bsd\*(C'\fR,
368:\&\f(CW\*(C`sysv\*(C'\fR, \f(CW\*(C`posix\*(C'\fR or
\f(CW\*(C`just\-symbols\*(C'\fR. The default is \f(CW\*(C`bsd\*(C'\fR.
388:to using the \f(CW\*(C`i\*(C'\fR character for both local indirect
functions and
413:function to be printed as well. For example, if \f(CW\*(C`main\*(C'\fR
inlines
414:\&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and
address is from
415:\&\f(CW\*(C`callee2\*(C'\fR, the source information for
\f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR
457:Print both value and size of defined symbols for the \f(CW\*(C`bsd\*(C'\fR
output style.
531:with the next higher value. If the \f(CW\*(C`bsd\*(C'\fR output format is
used
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:68: style: 3 leading space(s) on input line
an.tmac:<stdin>:69: style: 3 leading space(s) on input line
an.tmac:<stdin>:70: style: 3 leading space(s) on input line
an.tmac:<stdin>:71: style: 3 leading space(s) on input line
an.tmac:<stdin>:72: style: 3 leading space(s) on input line
an.tmac:<stdin>:73: style: 3 leading space(s) on input line
an.tmac:<stdin>:74: style: 3 leading space(s) on input line
an.tmac:<stdin>:75: style: 3 leading space(s) on input line
an.tmac:<stdin>:76: style: 3 leading space(s) on input line
an.tmac:<stdin>:77: style: 3 leading space(s) on input line
an.tmac:<stdin>:78: style: 3 leading space(s) on input line
an.tmac:<stdin>:79: style: 3 leading space(s) on input line
an.tmac:<stdin>:80: style: 3 leading space(s) on input line
an.tmac:<stdin>:81: style: 3 leading space(s) on input line
an.tmac:<stdin>:82: style: 3 leading space(s) on input line
an.tmac:<stdin>:83: style: 3 leading space(s) on input line
an.tmac:<stdin>:84: style: 3 leading space(s) on input line
an.tmac:<stdin>:85: style: 3 leading space(s) on input line
an.tmac:<stdin>:86: style: 3 leading space(s) on input line
an.tmac:<stdin>:87: style: 3 leading space(s) on input line
an.tmac:<stdin>:88: style: 3 leading space(s) on input line
an.tmac:<stdin>:89: style: 3 leading space(s) on input line
an.tmac:<stdin>:90: style: 3 leading space(s) on input line
an.tmac:<stdin>:91: style: 3 leading space(s) on input line
an.tmac:<stdin>:92: style: 3 leading space(s) on input line
an.tmac:<stdin>:93: style: 3 leading space(s) on input line
an.tmac:<stdin>:94: style: 3 leading space(s) on input line
an.tmac:<stdin>:95: style: 3 leading space(s) on input line
an.tmac:<stdin>:96: style: 3 leading space(s) on input line
an.tmac:<stdin>:97: style: 3 leading space(s) on input line
an.tmac:<stdin>:98: style: 3 leading space(s) on input line
an.tmac:<stdin>:99: style: 3 leading space(s) on input line
an.tmac:<stdin>:100: style: 3 leading space(s) on input line
an.tmac:<stdin>:126: style: use of deprecated macro: .PD
an.tmac:<stdin>:130: style: use of deprecated macro: .PD
an.tmac:<stdin>:137: style: use of deprecated macro: .PD
an.tmac:<stdin>:141: style: use of deprecated macro: .PD
an.tmac:<stdin>:151: style: use of deprecated macro: .PD
an.tmac:<stdin>:155: style: use of deprecated macro: .PD
an.tmac:<stdin>:160: style: use of deprecated macro: .PD
an.tmac:<stdin>:164: style: use of deprecated macro: .PD
an.tmac:<stdin>:206: style: use of deprecated macro: .PD
an.tmac:<stdin>:210: style: use of deprecated macro: .PD
an.tmac:<stdin>:215: style: use of deprecated macro: .PD
an.tmac:<stdin>:219: style: use of deprecated macro: .PD
an.tmac:<stdin>:225: style: use of deprecated macro: .PD
an.tmac:<stdin>:229: style: use of deprecated macro: .PD
an.tmac:<stdin>:245: style: use of deprecated macro: .PD
an.tmac:<stdin>:249: style: use of deprecated macro: .PD
an.tmac:<stdin>:258: style: use of deprecated macro: .PD
an.tmac:<stdin>:262: style: use of deprecated macro: .PD
an.tmac:<stdin>:297: style: use of deprecated macro: .PD
an.tmac:<stdin>:302: style: use of deprecated macro: .PD
an.tmac:<stdin>:308: style: use of deprecated macro: .PD
an.tmac:<stdin>:311: style: use of deprecated macro: .PD
an.tmac:<stdin>:319: style: use of deprecated macro: .PD
an.tmac:<stdin>:322: style: use of deprecated macro: .PD
an.tmac:<stdin>:333: style: use of deprecated macro: .PD
an.tmac:<stdin>:340: style: use of deprecated macro: .PD
an.tmac:<stdin>:354: style: use of deprecated macro: .PD
an.tmac:<stdin>:357: style: use of deprecated macro: .PD
an.tmac:<stdin>:363: style: use of deprecated macro: .PD
an.tmac:<stdin>:366: style: use of deprecated macro: .PD
an.tmac:<stdin>:373: style: use of deprecated macro: .PD
an.tmac:<stdin>:376: style: use of deprecated macro: .PD
an.tmac:<stdin>:380: style: use of deprecated macro: .PD
an.tmac:<stdin>:383: style: use of deprecated macro: .PD
an.tmac:<stdin>:399: style: use of deprecated macro: .PD
an.tmac:<stdin>:402: style: use of deprecated macro: .PD
troff:<stdin>:411: warning: trailing space in the line
an.tmac:<stdin>:419: style: use of deprecated macro: .PD
an.tmac:<stdin>:424: style: use of deprecated macro: .PD
an.tmac:<stdin>:429: style: use of deprecated macro: .PD
an.tmac:<stdin>:432: style: use of deprecated macro: .PD
an.tmac:<stdin>:437: style: use of deprecated macro: .PD
an.tmac:<stdin>:440: style: use of deprecated macro: .PD
an.tmac:<stdin>:445: style: use of deprecated macro: .PD
an.tmac:<stdin>:448: style: use of deprecated macro: .PD
an.tmac:<stdin>:453: style: use of deprecated macro: .PD
an.tmac:<stdin>:456: style: use of deprecated macro: .PD
an.tmac:<stdin>:463: style: use of deprecated macro: .PD
an.tmac:<stdin>:466: style: use of deprecated macro: .PD
an.tmac:<stdin>:472: style: use of deprecated macro: .PD
an.tmac:<stdin>:475: style: use of deprecated macro: .PD
an.tmac:<stdin>:480: style: use of deprecated macro: .PD
an.tmac:<stdin>:483: style: use of deprecated macro: .PD
an.tmac:<stdin>:488: style: use of deprecated macro: .PD
an.tmac:<stdin>:491: style: use of deprecated macro: .PD
an.tmac:<stdin>:496: style: use of deprecated macro: .PD
an.tmac:<stdin>:499: style: use of deprecated macro: .PD
an.tmac:<stdin>:565: style: use of deprecated macro: .PD
an.tmac:<stdin>:568: style: use of deprecated macro: .PD
an.tmac:<stdin>:572: style: use of deprecated macro: .PD
an.tmac:<stdin>:575: style: use of deprecated macro: .PD
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
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
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 -d -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 from 'diff -d -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)
-.-
