Package: binutils-common
Version: 2.43.50.20250108-1 (Debian testing)
Severity: minor
Tags: patch
* 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 ' $' <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?
an.tmac:<stdin>:68: style: 5 leading space(s) on input line
an.tmac:<stdin>:69: style: 5 leading space(s) on input line
an.tmac:<stdin>:70: style: 5 leading space(s) on input line
an.tmac:<stdin>:71: style: 5 leading space(s) on input line
an.tmac:<stdin>:72: style: 5 leading space(s) on input line
an.tmac:<stdin>:73: style: 5 leading space(s) on input line
an.tmac:<stdin>:74: style: 5 leading space(s) on input line
troff:<stdin>:83: warning: font name 'CW' is deprecated
an.tmac:<stdin>:89: style: use of deprecated macro: .PD
an.tmac:<stdin>:96: style: use of deprecated macro: .PD
an.tmac:<stdin>:161: style: use of deprecated macro: .PD
an.tmac:<stdin>:168: style: use of deprecated macro: .PD
an.tmac:<stdin>:172: style: use of deprecated macro: .PD
an.tmac:<stdin>:179: style: use of deprecated macro: .PD
an.tmac:<stdin>:196: style: use of deprecated macro: .PD
an.tmac:<stdin>:199: style: use of deprecated macro: .PD
an.tmac:<stdin>:209: style: use of deprecated macro: .PD
an.tmac:<stdin>:214: style: use of deprecated macro: .PD
* 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.6-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 size.1
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 size.1": (shortened list)
3 input text line longer than 80 bytes
-.-.
Output from "test-groff -mandoc -t -ww -z size.1": (shortened list)
1 font name 'CW' is deprecated
2 trailing space in the line
-.-.
Show if Pod::Man generated this
.\" 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
2
-.-.
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.
size.1:227:Copyright (c) 1991\-2025 Free Software Foundation, Inc.
-.-.
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.
Mark a final abbreviation point as such by suffixing it with "\&".
82:\&\fIobjfile\fR... are the files to be examined. If none are
-.-.
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 116, length 101
column, not in the \f(CW\*(C`data\*(C'\fR column, the \f(CW\*(C`dec\*(C'\fR and
\f(CW\*(C`hex\*(C'\fR
Line 117, length 87
columns both display the sum of the \f(CW\*(C`text\*(C'\fR,
\f(CW\*(C`data\*(C'\fR, and
Line 121, length 91
the \f(CW\*(C`text\*(C'\fR column, and only displays the sum of the
\f(CW\*(C`text\*(C'\fR,
Line 122, length 104
\&\f(CW\*(C`data\*(C'\fR, and \f(CW\*(C`bss\*(C'\fR columns once, in the
\f(CW\*(C`total\*(C'\fR column.
Line 224, length 97
\&\fBar\fR\|(1), \fBobjdump\fR\|(1), \fBreadelf\fR\|(1), and the Info entries
for \fIbinutils\fR.
-.-.
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".
Not considered in a patch, too many lines.
size.1:174:section is given in decimal (\fB\-d\fR, or \fB\-\-radix=10\fR); octal
size.1:190:Show totals of all objects listed (Berkeley or GNU format mode only).
-.-.
Put a subordinate sentence (after a comma) on a new line.
Not in a patch.
19:.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
33:.\" If the F register is >0, we'll generate index entries on stderr for
34:.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35:.\" entries marked with X<> in POD. Of course, you'll have to process the
59:.\" For nroff, turn off justification. Always turn off hyphenation; it makes
79:By default, one line of output is generated for each file or each
83:specified, the file \f(CW\*(C`a.out\*(C'\fR will be used instead.
97:Using one of these options, you can choose whether the output from GNU
99:or \fB\-\-format=sysv\fR), or Berkeley \fBsize\fR (using \fB\-B\fR, or
101:Berkeley's. Alternatively, you can choose the GNU format output
102:(using \fB\-G\fR, or \fB\-\-format=gnu\fR), this is similar to
103:Berkeley's output format, but sizes are counted differently.
116:column, not in the \f(CW\*(C`data\*(C'\fR column, the \f(CW\*(C`dec\*(C'\fR
and \f(CW\*(C`hex\*(C'\fR
117:columns both display the sum of the \f(CW\*(C`text\*(C'\fR,
\f(CW\*(C`data\*(C'\fR, and
120:The GNU format counts read only data in the \f(CW\*(C`data\*(C'\fR column,
not
121:the \f(CW\*(C`text\*(C'\fR column, and only displays the sum of the
\f(CW\*(C`text\*(C'\fR,
122:\&\f(CW\*(C`data\*(C'\fR, and \f(CW\*(C`bss\*(C'\fR columns once, in the
\f(CW\*(C`total\*(C'\fR column.
133:This is the same data, but displayed closer to System V conventions:
173:Using one of these options, you can control whether the size of each
174:section is given in decimal (\fB\-d\fR, or \fB\-\-radix=10\fR); octal
175:(\fB\-o\fR, or \fB\-\-radix=8\fR); or hexadecimal (\fB\-x\fR, or
176:\&\fB\-\-radix=16\fR). In \fB\-\-radix=\fR\fInumber\fR, only the three
177:values (8, 10, 16) are supported. The total size is always given in two
178:radices; decimal and hexadecimal for \fB\-d\fR or \fB\-x\fR output, or
208:program, but it is not supported by the GNU Binutils version.
213:does not exist, or cannot be read, then the option will be treated
214:literally, and not removed.
224:\&\fBar\fR\|(1), \fBobjdump\fR\|(1), \fBreadelf\fR\|(1), and the Info
entries for \fIbinutils\fR.
227:Copyright (c) 1991\-2025 Free Software Foundation, Inc.
229:Permission is granted to copy, distribute and/or modify this document
230:under the terms of the GNU Free Documentation License, Version 1.3
232:with no Invariant Sections, with no Front-Cover Texts, and with no
-.-.
Use ".na" (no-adjustment) instead of ".ad l".
After temporary no-adjustment, use ".ad" to begin the
same adjustment again as before.
61:.if n .ad l
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:83: warning: font name 'CW' is deprecated
an.tmac:<stdin>:89: style: use of deprecated macro: .PD
an.tmac:<stdin>:96: style: use of deprecated macro: .PD
troff:<stdin>:143: warning: trailing space in the line
troff:<stdin>:144: warning: trailing space in the line
an.tmac:<stdin>:154: style: use of deprecated macro: .PD
an.tmac:<stdin>:161: style: use of deprecated macro: .PD
an.tmac:<stdin>:165: style: use of deprecated macro: .PD
an.tmac:<stdin>:172: style: use of deprecated macro: .PD
an.tmac:<stdin>:186: style: use of deprecated macro: .PD
an.tmac:<stdin>:189: style: use of deprecated macro: .PD
an.tmac:<stdin>:198: style: use of deprecated macro: .PD
an.tmac:<stdin>:203: style: use of deprecated macro: .PD
-.-.
--- size.1 2025-01-14 13:14:20.426170904 +0000
+++ size.1.new 2025-01-14 13:46:58.735091810 +0000
@@ -4,7 +4,7 @@
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
.de Vb \" Begin verbatim text
@@ -58,7 +58,7 @@
.TH SIZE 1 2025-01-08 binutils-2.43.50 "GNU Development Tools"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
-.if n .ad l
+.if n .na
.nh
.SH NAME
size \- list section sizes and total size of binary files
@@ -79,7 +79,7 @@ size for each of the binary files \fIobj
By default, one line of output is generated for each file or each
module if the file is an archive.
.PP
-\&\fIobjfile\fR... are the files to be examined. If none are
+\&\fIobjfile\fR...\& are the files to be examined. If none are
specified, the file \f(CW\*(C`a.out\*(C'\fR will be used instead.
.SH OPTIONS
.IX Header "OPTIONS"
@@ -113,15 +113,22 @@ Here is an example of the Berkeley (defa
.Ve
.Sp
The Berkeley style output counts read only data in the \f(CW\*(C`text\*(C'\fR
-column, not in the \f(CW\*(C`data\*(C'\fR column, the \f(CW\*(C`dec\*(C'\fR
and \f(CW\*(C`hex\*(C'\fR
-columns both display the sum of the \f(CW\*(C`text\*(C'\fR,
\f(CW\*(C`data\*(C'\fR, and
+column,
+not in the \f(CW\*(C`data\*(C'\fR column,
+the \f(CW\*(C`dec\*(C'\fR and \f(CW\*(C`hex\*(C'\fR
+columns both display the sum of the \f(CW\*(C`text\*(C'\fR,
+\f(CW\*(C`data\*(C'\fR, and
\&\f(CW\*(C`bss\*(C'\fR columns in decimal and hexadecimal respectively.
.Sp
-The GNU format counts read only data in the \f(CW\*(C`data\*(C'\fR column, not
-the \f(CW\*(C`text\*(C'\fR column, and only displays the sum of the
\f(CW\*(C`text\*(C'\fR,
-\&\f(CW\*(C`data\*(C'\fR, and \f(CW\*(C`bss\*(C'\fR columns once, in the
\f(CW\*(C`total\*(C'\fR column.
+The GNU format counts read only data in the \f(CW\*(C`data\*(C'\fR column,
+not the \f(CW\*(C`text\*(C'\fR column,
+and only displays the sum of the \f(CW\*(C`text\*(C'\fR,
+\&\f(CW\*(C`data\*(C'\fR,
+and \f(CW\*(C`bss\*(C'\fR columns once,
+in the \f(CW\*(C`total\*(C'\fR column.
The \fB\-\-radix\fR option can be used to change the number base for
-all columns. Here is the same data displayed with GNU conventions:
+all columns.
+Here is the same data displayed with GNU conventions:
.Sp
.Vb 4
\& $ size \-\-format=GNU ranlib size
@@ -140,8 +147,8 @@ This is the same data, but displayed clo
\& .data 81920 303104
\& .bss 11592 385024
\& Total 388392
-\&
-\&
+\&
+\&
\& size :
\& section size addr
\& .text 294880 8192
@@ -171,8 +178,11 @@ Show a summary of acceptable arguments a
.IX Item "--radix=number"
.PD
Using one of these options, you can control whether the size of each
-section is given in decimal (\fB\-d\fR, or \fB\-\-radix=10\fR); octal
-(\fB\-o\fR, or \fB\-\-radix=8\fR); or hexadecimal (\fB\-x\fR, or
+section is given in decimal
+(\fB\-d\fR, or \fB\-\-radix=10\fR);
+octal
+(\fB\-o\fR, or \fB\-\-radix=8\fR);
+or hexadecimal (\fB\-x\fR, or
\&\fB\-\-radix=16\fR). In \fB\-\-radix=\fR\fInumber\fR, only the three
values (8, 10, 16) are supported. The total size is always given in two
radices; decimal and hexadecimal for \fB\-d\fR or \fB\-x\fR output, or
@@ -187,7 +197,8 @@ or GNU format these are included in the
.IP \fB\-\-totals\fR 4
.IX Item "--totals"
.PD
-Show totals of all objects listed (Berkeley or GNU format mode only).
+Show totals of all objects listed
+(Berkeley or GNU format mode only).
.IP \fB\-\-target=\fR\fIbfdname\fR 4
.IX Item "--target=bfdname"
Specify that the object-code format for \fIobjfile\fR is
@@ -221,10 +232,11 @@ with a backslash. The \fIfile\fR may it
@\fIfile\fR options; any such options will be processed recursively.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-\&\fBar\fR\|(1), \fBobjdump\fR\|(1), \fBreadelf\fR\|(1), and the Info entries
for \fIbinutils\fR.
+\&\fBar\fR\|(1), \fBobjdump\fR\|(1), \fBreadelf\fR\|(1),
+and the Info entries for \fIbinutils\fR.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
-Copyright (c) 1991\-2025 Free Software Foundation, Inc.
+Copyright (c) 1991\(en2025 Free Software Foundation, Inc.
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
