Package: attr
Version: 1:2.5.2-4
Severity: minor
Tags: patch
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:60: warning: trailing space in the line
troff:<stdin>:90: 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.18.12+deb14-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 attr depends on:
ii libattr1 1:2.5.2-4
ii libc6 2.42-13
attr recommends no packages.
attr suggests no packages.
-- no debconf information
Input file is getfattr.1
Output from "mandoc -T lint getfattr.1": (shortened list)
2 STYLE: whitespace at end of input line
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -Kutf8 -ww -z getfattr.1: (shortened list)
2 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Input file is getfattr.1
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
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
90:is "^user\\\\.",
-.-.
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"
38:are associated with that file. Per default only attributes in the user
81:Do not dereference symlinks. Instead of the file a symlink refers to, the
91:which includes all the attributes in the user namespace. Specify "\-" for
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
getfattr.1:37:and the set of extended attribute names (and optionally values)
which
getfattr.1:58:The remaining lines (lines 2 to 4 above) show the
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
getfattr.1:38:are associated with that file. Per default only attributes in the
user
getfattr.1:81:Do not dereference symlinks. Instead of the file a symlink refers
to, the
getfattr.1:91:which includes all the attributes in the user namespace. Specify
"\-" for
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
getfattr.1:65:.BR \-n " \fIname\fR, " \-\-name "=\fIname\fR"
getfattr.1:71:.BR \-e " \fIen\fR, " \-\-encoding "=\fIen\fR"
getfattr.1:85:.BR \-m " \fIpattern\fR, " \-\-match "=\fIpattern\fR"
-.-.
Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
137:.RI < https://savannah.nongnu.org/bugs/?group=attr >
-.-.
Change comment lines of type '.\" ====' (and an empty '.\"' line) to
a single period, as they contain no information and waste work each time
they are processed.
3:.\"
8:.\"
13:.\"
18:.\"
22:.\"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:60: warning: trailing space in the line
troff:<stdin>:90: warning: trailing space in the line
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Additionally
"=" is typeset bold when it is to be input as such.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block(, when the table gets wider than the output line).
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment (l, L) is sufficient.
--- getfattr.1 2026-02-26 22:28:20.818394529 +0000
+++ getfattr.1.new 2026-02-26 22:59:27.525617914 +0000
@@ -1,25 +1,25 @@
.\" Copyright (C) 2002, 2004, 2007 Silicon Graphics, Inc. All rights reserved.
.\" Copyright (C) 2002, 2004, 2007 Andreas Gruenbacher <[email protected]>
-.\"
+.
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
-.\"
+.
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
-.\"
+.
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
-.\"
+.
.\" You should have received a copy of the GNU General Public
.\" License along with this manual. If not, see
.\" <http://www.gnu.org/licenses/>.
-.\"
+.
.TH GETFATTR 1 "Extended Attributes" "Dec 2001" "File Utilities"
.SH NAME
getfattr \- get extended attributes of filesystem objects
@@ -57,18 +57,18 @@ Line 1 identifies the file name for whic
following lines are being reported.
The remaining lines (lines 2 to 4 above) show the
.I name
-and
+and
.I value
pairs associated with the specified file.
.SH OPTIONS
.TP 4
-.BR \-n " \fIname\fR, " \-\-name "=\fIname\fR"
+.BR \-n " \fIname\fR, " \-\-name= \fIname\fR
Dump the value of the named extended attribute.
.TP
.BR \-d ", " \-\-dump
Dump the values of all matched extended attributes.
.TP
-.BR \-e " \fIen\fR, " \-\-encoding "=\fIen\fR"
+.BR \-e " \fIen\fR, " \-\-encoding= \fIen\fR
Encode values after retrieving them.
Valid values of
.I en
@@ -82,12 +82,12 @@ Do not dereference symlinks. Instead of
symlink itself is examined. Unless doing a logical (\-L) traversal, do not
traverse symlinks to directories.
.TP
-.BR \-m " \fIpattern\fR, " \-\-match "=\fIpattern\fR"
+.BR \-m " \fIpattern\fR, " \-\-match= \fIpattern\fR
Only include attributes with names matching the regular expression
.IR pattern .
The default value for
.I pattern
-is "^user\\\\.",
+is "^user\e\e.",
which includes all the attributes in the user namespace. Specify "\-" for
including all attributes. Refer to
.BR xattr (7)
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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 when that has been fixed.
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)
-.-
