Package: binutils-common
Version: 2.43.50.20250108-1
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: 8 leading space(s) on input line
an.tmac:<stdin>:69: style: 8 leading space(s) on input line
an.tmac:<stdin>:70: style: 8 leading space(s) on input line
an.tmac:<stdin>:71: style: 8 leading space(s) on input line
an.tmac:<stdin>:72: style: 8 leading space(s) on input line
an.tmac:<stdin>:73: style: 8 leading space(s) on input line
an.tmac:<stdin>:74: style: 8 leading space(s) on input line
an.tmac:<stdin>:75: style: 8 leading space(s) on input line
an.tmac:<stdin>:76: style: 8 leading space(s) on input line
an.tmac:<stdin>:101: style: use of deprecated macro: .PD
an.tmac:<stdin>:106: style: use of deprecated macro: .PD
an.tmac:<stdin>:118: style: use of deprecated macro: .PD
an.tmac:<stdin>:121: style: use of deprecated macro: .PD
an.tmac:<stdin>:131: style: use of deprecated macro: .PD
an.tmac:<stdin>:134: style: use of deprecated macro: .PD
an.tmac:<stdin>:141: style: use of deprecated macro: .PD
an.tmac:<stdin>:146: style: use of deprecated macro: .PD
troff:<stdin>:150: warning: trailing space in the line
an.tmac:<stdin>:161: style: use of deprecated macro: .PD
an.tmac:<stdin>:164: style: use of deprecated macro: .PD
an.tmac:<stdin>:170: style: use of deprecated macro: .PD
an.tmac:<stdin>:173: style: use of deprecated macro: .PD
an.tmac:<stdin>:183: style: use of deprecated macro: .PD
an.tmac:<stdin>:186: style: use of deprecated macro: .PD
an.tmac:<stdin>:208: style: use of deprecated macro: .PD
an.tmac:<stdin>:211: style: use of deprecated macro: .PD
an.tmac:<stdin>:215: style: use of deprecated macro: .PD
an.tmac:<stdin>:220: style: use of deprecated macro: .PD
an.tmac:<stdin>:224: style: use of deprecated macro: .PD
an.tmac:<stdin>:227: style: use of deprecated macro: .PD
an.tmac:<stdin>:234: style: use of deprecated macro: .PD
an.tmac:<stdin>:237: 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 strings.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 strings.1": (shortened list)
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z strings.1": (shortened list)
1 trailing space in the line
-.-.
Show if Pod::Man generated this
Who is actually creating the man page? Debian or upstream?
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.
strings.1:261: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 "\&".
179:littleendian. Useful for finding wide character strings. (\fBl\fR
238:By default, output strings are delimited by a new-line. This option
-.-.
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 257, length 89
\&\fBar\fR\|(1), \fBnm\fR\|(1), \fBobjdump\fR\|(1), \fBranlib\fR\|(1),
\fBreadelf\fR\|(1)
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
Not in a patch.
67:strings [\fB\-afovV\fR] [\fB\-\fR\fImin-len\fR]
68: [\fB\-n\fR \fImin-len\fR] [\fB\-\-bytes=\fR\fImin-len\fR]
69: [\fB\-t\fR \fIradix\fR] [\fB\-\-radix=\fR\fIradix\fR]
70: [\fB\-e\fR \fIencoding\fR] [\fB\-\-encoding=\fR\fIencoding\fR]
71: [\fB\-U\fR \fImethod\fR] [\fB\-\-unicode=\fR\fImethod\fR]
73: [\fB\-T\fR \fIbfdname\fR] [\fB\-\-target=\fR\fIbfdname\fR]
139:.IP \fB\-\fR\fImin-len\fR 4
144:.IP \fB\-\-bytes=\fR\fImin-len\fR 4
162:.IP \fB\-\-radix=\fR\fIradix\fR 4
171:.IP \fB\-\-encoding=\fR\fIencoding\fR 4
184:.IP \fB\-\-unicode=\fR\fI[default|invalid|locale|escape|hex|highlight]\fR 4
209:.IP \fB\-\-target=\fR\fIbfdname\fR 4
242:.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".
Not in a patch.
strings.1:188:The default (\fB\-\-unicode=default\fR) is to give them no special
strings.1:201:option displays them as escape sequences (\fI\euxxxx\fR) and the
strings.1:203:highlighted in red (if supported by the output device). The
colouring
-.-.
Put a subordinate sentence (after a comma) on a new line.
Not in a patch.
79:For each \fIfile\fR given, GNU \fBstrings\fR prints the
86:each file, or only those sequences that are in loadable, initialized
87:data sections. If the file type is unrecognizable, or if strings is
92:option of just \fB\-\fR will also be scanned in full, regardless of
107:Scan the whole file, regardless of what sections it contains or
109:the default behaviour, but strings can be configured so that the
114:on the command line, even if the \fB\-d\fR option has been
122:Only print strings from initialized, loaded data sections in the
123:file. This may reduce the amount of garbage in the output, but it
152:at control characters such as new-line and carriage-return, but not
158:ways, we simply chose one.
167:octal, \fBx\fR for hexadecimal, or \fBd\fR for decimal.
176:characters (default), \fBS\fR =
177:single\-8\-bit\-byte characters, \fBb\fR = 16\-bit bigendian, \fBl\fR =
178:16\-bit littleendian, \fBB\fR = 32\-bit bigendian, \fBL\fR = 32\-bit
180:and \fBb\fR apply to, for example, Unicode UTF\-16/UCS\-2 encodings).
189:treatment, and instead rely upon the setting of the
198:locale, which may or may not support UTF\-8 encoding. The
229:are displayed, but other whitespace characters, such a newlines and
230:carriage returns, are not. The \fB\-w\fR option changes this so
238:By default, output strings are delimited by a new-line. This option
246:does not exist, or cannot be read, then the option will be treated
247:literally, and not removed.
257:\&\fBar\fR\|(1), \fBnm\fR\|(1), \fBobjdump\fR\|(1), \fBranlib\fR\|(1),
\fBreadelf\fR\|(1)
261:Copyright (c) 1991\-2025 Free Software Foundation, Inc.
263:Permission is granted to copy, distribute and/or modify this document
264:under the terms of the GNU Free Documentation License, Version 1.3
266:with no Invariant Sections, with no Front-Cover Texts, and with no
-.-.
Use ".na" (no adjustment) instead of "ad l" and then ".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
":
an.tmac:<stdin>:68: style: 8 leading space(s) on input line
an.tmac:<stdin>:69: style: 8 leading space(s) on input line
an.tmac:<stdin>:70: style: 8 leading space(s) on input line
an.tmac:<stdin>:71: style: 8 leading space(s) on input line
an.tmac:<stdin>:72: style: 8 leading space(s) on input line
an.tmac:<stdin>:73: style: 8 leading space(s) on input line
an.tmac:<stdin>:74: style: 8 leading space(s) on input line
an.tmac:<stdin>:75: style: 8 leading space(s) on input line
an.tmac:<stdin>:76: style: 8 leading space(s) on input line
an.tmac:<stdin>:101: style: use of deprecated macro: .PD
an.tmac:<stdin>:106: style: use of deprecated macro: .PD
an.tmac:<stdin>:118: style: use of deprecated macro: .PD
an.tmac:<stdin>:121: style: use of deprecated macro: .PD
an.tmac:<stdin>:131: style: use of deprecated macro: .PD
an.tmac:<stdin>:134: style: use of deprecated macro: .PD
an.tmac:<stdin>:141: style: use of deprecated macro: .PD
an.tmac:<stdin>:146: style: use of deprecated macro: .PD
troff:<stdin>:150: warning: trailing space in the line
an.tmac:<stdin>:161: style: use of deprecated macro: .PD
an.tmac:<stdin>:164: style: use of deprecated macro: .PD
an.tmac:<stdin>:170: style: use of deprecated macro: .PD
an.tmac:<stdin>:173: style: use of deprecated macro: .PD
an.tmac:<stdin>:183: style: use of deprecated macro: .PD
an.tmac:<stdin>:186: style: use of deprecated macro: .PD
an.tmac:<stdin>:208: style: use of deprecated macro: .PD
an.tmac:<stdin>:211: style: use of deprecated macro: .PD
an.tmac:<stdin>:215: style: use of deprecated macro: .PD
an.tmac:<stdin>:220: style: use of deprecated macro: .PD
an.tmac:<stdin>:224: style: use of deprecated macro: .PD
an.tmac:<stdin>:227: style: use of deprecated macro: .PD
an.tmac:<stdin>:234: style: use of deprecated macro: .PD
an.tmac:<stdin>:237: style: use of deprecated macro: .PD
-.-
Additionally:
Change '\-\-\-' to ' \(en '.
-.-
Use correct typeface for character '|' in an argument to macro '.IP'
for example with:
.ds se \fR|\fP
and use '\*(se' instead of plain '|' in the argument.
--- strings.1 2025-01-14 18:49:28.525217519 +0000
+++ strings.1.new 2025-01-14 19:45:24.083203771 +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 STRINGS 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
strings \- print the sequences of printable characters in files
@@ -147,7 +147,7 @@ Print a summary of the program usage on
Print sequences of displayable characters that are at least
\&\fImin-len\fR characters long. If not specified a default minimum
length of 4 is used. The distinction between displayable and
-non-displayable characters depends upon the setting of the
+non-displayable characters depends upon the setting of the
\&\fB\-e\fR and \fB\-U\fR options. Sequences are always terminated
at control characters such as new-line and carriage-return, but not
the tab character.
@@ -163,7 +163,7 @@ ways, we simply chose one.
.IX Item "--radix=radix"
.PD
Print the offset within the file before each string. The single
-character argument specifies the radix of the offset\-\-\-\fBo\fR for
+character argument specifies the radix of the offset \(en \fBo\fR for
octal, \fBx\fR for hexadecimal, or \fBd\fR for decimal.
.IP "\fB\-e\fR \fIencoding\fR" 4
.IX Item "-e encoding"
@@ -176,12 +176,13 @@ Possible values for \fIencoding\fR are:
characters (default), \fBS\fR =
single\-8\-bit\-byte characters, \fBb\fR = 16\-bit bigendian, \fBl\fR =
16\-bit littleendian, \fBB\fR = 32\-bit bigendian, \fBL\fR = 32\-bit
-littleendian. Useful for finding wide character strings. (\fBl\fR
-and \fBb\fR apply to, for example, Unicode UTF\-16/UCS\-2 encodings).
-.IP "\fB\-U\fR \fI[d|i|l|e|x|h]\fR" 4
+littleendian. Useful for finding wide character strings.
+(\fBl\fR and \fBb\fR apply to, for example, Unicode UTF\-16/UCS\-2 encodings).
+.ds se \fR|\fP
+.IP "\fB\-U\fR [\fBd\*(sei\*(sel\*(see\*(sex\*(seh\fR]" 4
.IX Item "-U [d|i|l|e|x|h]"
.PD 0
-.IP \fB\-\-unicode=\fR\fI[default|invalid|locale|escape|hex|highlight]\fR 4
+.IP
\fB\-\-unicode=\fR[\fBdefault\*(seinvalid\*(selocale\*(seescape\*(sehex\*(sehighlight\fR]
4
.IX Item "--unicode=[default|invalid|locale|escape|hex|highlight]"
.PD
Controls the display of UTF\-8 encoded multibyte characters in strings.
@@ -235,7 +236,8 @@ that all whitespace characters are consi
.IP \fB\-\-output\-separator\fR 4
.IX Item "--output-separator"
.PD
-By default, output strings are delimited by a new-line. This option
+By default, output strings are delimited by a new-line.
+This option
allows you to supply any string to be used as the output record
separator. Useful with \-\-include\-all\-whitespace where strings
may contain new-lines internally.
@@ -254,11 +256,12 @@ 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), \fBnm\fR\|(1), \fBobjdump\fR\|(1), \fBranlib\fR\|(1),
\fBreadelf\fR\|(1)
+\&\fBar\fR\|(1), \fBnm\fR\|(1), \fBobjdump\fR\|(1), \fBranlib\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
