Package: libdebuginfod-common Version: 0.196-1 Severity: minor Tags: patch Additional remarks.
Mails from me to "[email protected]" are no longer acknowledged. A Debian maintainer told me, that he would contact the mail administrator about me not wanting to send bugs upstream. -.- Dear Maintainer, >From "ftp.debian.org/debian/doc/bug-reporting.txt" Don't file bugs upstream If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself to start with, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream, or ask you to do so after they've checked that it isn't Debian-specific. -.- For forwarding bug reports to upstream see: https://www.debian.org/Bugs/Developer#forward -.- "Handling bug reports" in http://people.debian.org/~enrico/dcg/ch03s02.html -.- I do not send reports upstream if I have to get an account there. The Debian maintainers have one already. -.- * 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 ' \\"' -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 -K utf8 -rF0 -rHY=0 -ww -z -t": troff:<stdin>:3: warning: register 'zZ' not defined [-w reg] troff:<stdin>:13: warning: name 'zZ' not defined [-w mac] troff:<stdin>:16: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:23: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:28: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:34: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:36: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:37: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:46: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:46: warning: trailing whitespace [-w trail] troff:<stdin>:62: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:67: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:69: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:70: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:76: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:124: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:128: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:130: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:135: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:135: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:157: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:157: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:162: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:162: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:168: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:170: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:171: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:171: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:177: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:178: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:179: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:180: warning: end of sentence detected before end of text line [-w style] * 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 7.1.13+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 libdebuginfod-common depends on: ii debconf [debconf-2.0] 1.5.92 ii ucf 3.0056 libdebuginfod-common recommends no packages. libdebuginfod-common suggests no packages. -- debconf information excluded
Input file is debuginfod-client-config.7
Output from "mandoc -T lint debuginfod-client-config.7": (shortened list)
1 ERROR: skipping unknown macro: .zZ
2 STYLE: input text line longer than 80 bytes
1 STYLE: whitespace at end of input line
1 WARNING: missing date, using "": TH
Find trailing whitespace with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page>
-.-.
Output from
test-groff mandoc -t -Kutf8 -Tutf8 -ww -z debuginfod-client-config.7:
(shortened list)
29 end of sentence detected before end of text line [-w style]
1 name 'zZ' not defined [-w mac]
1 register 'zZ' not defined [-w reg]
1 trailing whitespace [-w trail]
Find trailing whitespace with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page>
-.-.
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".
See more information in the attachment "trailing whitespace".
Number of lines affected is
1
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
90:fails to provide at least 100K of data within the timeout. The default is
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
90:fails to provide at least 100K of data within the timeout. The default is
-.-.
Wrong distance (not two spaces, not a new line character (\n)) between
sentences in the input file.
mandoc(1) says: "New sentence, new line."
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"
81:This environment variable governs the default limit of retry attempts. If a
88:timeout, in seconds, for each debuginfod HTTP connection. A server is
90:fails to provide at least 100K of data within the timeout. The default is
91:90 seconds. (Zero or negative means "no timeout".)
96:\fIcomplete\fP the download a file found on a server in seconds. It is best
97:used to ensure that a file is downloaded quickly or be rejected. The
103:download in bytes. This is best used if the user would like to ensure
104:only small files are downloaded. A value of 0 causes no consideration
111:outbound HTTP requests, one per line. The header lines shouldn't end with
112:CRLF, unless that's the system newline convention. Whitespace-only lines
-.-.
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 7, length 97
debuginfod-client-config \- debuginfod client environment variables, cache
control files and etc.
Line 10, length 104
Several environment variables and control files control the behaviour of
debuginfod client applications.
Line 12, length 82
.\" The preceding section permits this man page to be viewed as if
self-contained.
Line 41, length 112
DEBUGINFOD_URLS="https://foo.com ima:enforcing https://bar.ca
http://localhost:8002/ ima:ignore https://baz.org";
Longest line is number 41 with 112 characters
-.-.
Use the name of units in text; use symbols in tables and
calculations.
The rule is to have a (no-break, "\ " or "\~") space between a number and
its units (see "www.bipm.org/en/publications/si-brochure")
90:fails to provide at least 100K of data within the timeout. The default is
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
debuginfod-client-config.7:91:90 seconds. (Zero or negative means "no timeout".)
debuginfod-client-config.7:98:default is 0 (infinite time).
debuginfod-client-config.7:106:The default is 0 (infinite size).
debuginfod-client-config.7:178:short-circuited (repeating the same results).
This accelerates
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Start a new sentence on a new line.
mandoc(1) says "New sentence, new line."
debuginfod-client-config.7:81:This environment variable governs the default
limit of retry attempts. If a
debuginfod-client-config.7:88:timeout, in seconds, for each debuginfod HTTP
connection. A server is
debuginfod-client-config.7:90:fails to provide at least 100K of data within the
timeout. The default is
debuginfod-client-config.7:91:90 seconds. (Zero or negative means "no timeout".)
debuginfod-client-config.7:96:\fIcomplete\fP the download a file found on a
server in seconds. It is best
debuginfod-client-config.7:97:used to ensure that a file is downloaded quickly
or be rejected. The
debuginfod-client-config.7:103:download in bytes. This is best used if the user
would like to ensure
debuginfod-client-config.7:104:only small files are downloaded. A value of 0
causes no consideration
debuginfod-client-config.7:111:outbound HTTP requests, one per line. The header
lines shouldn't end with
debuginfod-client-config.7:112:CRLF, unless that's the system newline
convention. Whitespace-only lines
-.-.
Additionally:
Make sure zZ is defined.
Size/bytes:
6558 debuginfod-client-config.7
6608 debuginfod-client-config.7.new
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
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.
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient. There is thereby no change in the standard output.
--- debuginfod-client-config.7 2026-09-11 20:11:42.251408783 +0000 +++ debuginfod-client-config.7.new 2026-09-11 20:33:30.214578598 +0000 @@ -1,5 +1,6 @@ '\"! tbl | nroff \-man '\" t macro stdmacro +.nr zZ +0\" initialize variable if not defined .if \n(zZ=1 .ig zZ .TH DEBUGINFOD-CLIENT-CONFIG 7 @@ -43,7 +44,7 @@ DEBUGINFOD_URLS="https://foo.com ima:enf .in Where foo.com and baz.org use the default \fIignore\fP policy and -bar.ca and localhost use an \fIenforcing\fP policy. The policy tag +bar.ca and localhost use an \fIenforcing\fP policy. The policy tag may be one of the following: .IP \fIima:enforcing\fP Every downloaded file requires a valid signature, @@ -87,7 +88,7 @@ within the limit. This environment variable governs the download \fIcommencing\fP timeout, in seconds, for each debuginfod HTTP connection. A server is skipped if it either fails to establish a connection within the timeout or -fails to provide at least 100K of data within the timeout. The default is +fails to provide at least 100\~KiB of data within the timeout. The default is 90 seconds. (Zero or negative means "no timeout".) .TP
Check the output from "lintian" in the Debian distribution. 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 most trailing spaces use grep -n -e ' $' -e ' \\f.$' -e ' \\"' -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. Debian can fix simple bugs in the used generators and distribute them, and does not need to wait for upstream to do that and distribute them. -.- 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 a script "cmp.manuals" in the attachment. Or 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) -.-
cmp.manuals.gz
Description: application/gzip
--- Begin Message ---Trailing whitespace is so unnecessary, that its presence may be removed before files containing it are distributed. Some programs have a tool to point out its presence, like gcc with option "-Wtrailing-whitespace" git with option "apply --whitespace=..." and in ".git/config" [core] whitespace=... grep with option -e '[[:blank:]]$' less with command "/ $" mandoc -T lint default action
--- End Message ---
