Package: libdebuginfod-common
Version: 0.192-4
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 ' $' -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?
troff:<stdin>:3: warning: register 'zZ' not defined
an.tmac:<stdin>:5: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:5: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:13: warning: name 'zZ' not defined
troff:<stdin>:44: warning: trailing space in the line
an.tmac:<stdin>:139: style: use of deprecated macro: .PD
an.tmac:<stdin>:144: style: use of deprecated macro: .PD
an.tmac:<stdin>:149: 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.12-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.89
ii ucf 3.0049
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 input text line longer than 80 bytes: Several environment ...
1 input text line longer than 80 bytes: debuginfod-client-co...
1 missing date, using "": TH
1 skipping unknown macro: .zZ
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z debuginfod-client-config.7":
(shortened list)
1 name 'zZ' not defined
1 register 'zZ' not defined
1 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
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 (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.
87:provide at least 100K of data within this many seconds is skipped. The
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
87:provide at least 100K of data within this many seconds is skipped. The
-.-.
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 "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
N.B.
The number of lines affected can be too large to be in a patch.
Lines with only one space between sentences are let starting a new line.
21:temporary files. The default is /tmp.
26:debuginfod instances. Alternate URL prefixes are separated by space.
32:RPMs. As the space seperated list is read left to right, upon
34:using that specified policy. All URLs before the first tag will use
35:the default policy, \fIima:ignore\fP. For example:
44:bar.ca and localhost use an \fIenforcing\fP policy. The policy tag
60:downloaded files and cache-control files are kept. The default
65:This environment variable governs the default progress function. If
67:configure a default progressfn. This function will append a simple
68:progress message periodically to stderr. The default is no progress
74:verbose output. If set, and if a verbose fd is not explicitly set,
79:This environment variable governs the default limit of retry attempts. If a
86:timeout for each debuginfod HTTP connection. A server that fails to
87:provide at least 100K of data within this many seconds is skipped. The
88:default is 90 seconds. (Zero or negative means "no timeout".)
93:\fIcomplete\fP the download a file found on a server in seconds. It is best
94:used to ensure that a file is downloaded quickly or be rejected. The
100:download in bytes. This is best used if the user would like to ensure
101:only small files are downloaded. A value of 0 causes no consideration
108:outbound HTTP requests, one per line. The header lines shouldn't end with
109:CRLF, unless that's the system newline convention. Whitespace-only lines
121:clean the cache. If it's time to clean, the library traverses the
125:Control files are located directly under the cache directory. They
127:parameters. If the files do not exist, the client library creates the
132:build-id. A failed query is also cached by a special file. The
154:seconds. The default is 86400, one day. 0 means "immediately".
159:are retained, in seconds. The default is 604800, one week. 0 means
165:seconds. New queries for the same artifacts within this time window
167:a new query to servers). This accelerates queries that probably would
168:still fail. The default is 600, 10 minutes. 0 means "forget
174:query. New queries for the same artifacts within this time window are
175:short-circuited (repeating the same results). This accelerates
176:queries that probably would probably have the same results. The
177:default is 3600, 1 hour. 0 means "do not retain".
-.-.
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 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 39, length 112
DEBUGINFOD_URLS="https://foo.com ima:enforcing https://bar.ca
http://localhost:8002/ ima:ignore https://baz.org";
-.-.
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:88:default is 90 seconds. (Zero or negative means
"no timeout".)
debuginfod-client-config.7:175:short-circuited (repeating the same results).
This accelerates
-.-.
Use thousand markers to make large numbers easy to read
154:seconds. The default is 86400, one day. 0 means "immediately".
159:are retained, in seconds. The default is 604800, one week. 0 means
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:3: warning: register 'zZ' not defined
an.tmac:<stdin>:5: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:5: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:13: warning: name 'zZ' not defined
troff:<stdin>:44: warning: trailing space in the line
an.tmac:<stdin>:139: style: use of deprecated macro: .PD
an.tmac:<stdin>:144: style: use of deprecated macro: .PD
an.tmac:<stdin>:149: style: use of deprecated macro: .PD
-.-.
Spelling (codespell):
seperated ==> separated
-.-
Additionally:
Define register zZ, if not alreay so.
Define macro zZ as empty, if not already non-empty.
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- debuginfod-client-config.7 2025-02-20 19:34:54.451235521 +0000
+++ debuginfod-client-config.7.new 2025-02-20 20:12:30.620031153 +0000
@@ -1,13 +1,17 @@
'\"! tbl | nroff \-man
'\" t macro stdmacro
+.nr zZ +0\" define register, if not alredy so
+.as zZ "\" add empty string and thus define if undefined
.if \n(zZ=1 .ig zZ
.TH DEBUGINFOD-CLIENT-CONFIG 7
.SH NAME
-debuginfod-client-config \- debuginfod client environment variables, cache
control files and etc.
+debuginfod-client-config \- debuginfod client environment variables,
+cache control files and etc.
.SH SYNOPSIS
-Several environment variables and control files control the behaviour of
debuginfod client applications.
+Several environment variables and control files
+control the behaviour of debuginfod client applications.
.\" The preceding section permits this man page to be viewed as if
self-contained.
.zZ
@@ -23,7 +27,7 @@ temporary files. The default is /tmp.
.TP
.B $DEBUGINFOD_URLS
This environment variable contains a list of URL prefixes for trusted
-debuginfod instances. Alternate URL prefixes are separated by space.
+debuginfod instances. Alternate URL prefixes are seperated by space.
This environment variable may be set by /etc/profile.d scripts
reading /etc/debuginfod/*.urls files.
@@ -36,12 +40,13 @@ the default policy, \fIima:ignore\fP. F
.in +4n
.EX
-DEBUGINFOD_URLS="https://foo.com ima:enforcing https://bar.ca
http://localhost:8002/ ima:ignore https://baz.org";
+DEBUGINFOD_URLS="https://foo.com ima:enforcing https://bar.ca\: \e
+http://localhost:8002/ ima:ignore https://baz.org";
.EE
.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,
@@ -76,44 +81,48 @@ then the verbose output will be produced
.TP
.B $DEBUGINFOD_RETRY_LIMIT
-This environment variable governs the default limit of retry attempts. If a
-query failed with errno other than ENOENT, will initiate several attempts
-within the limit.
+This environment variable governs the default limit of retry attempts.
+If a query failed with errno other than ENOENT,
+will initiate several attempts within the limit.
.TP
.B $DEBUGINFOD_TIMEOUT
This environment variable governs the download \fIcommencing\fP
timeout for each debuginfod HTTP connection. A server that fails to
-provide at least 100K of data within this many seconds is skipped. The
-default is 90 seconds. (Zero or negative means "no timeout".)
+provide at least 100\~KiB of data within this many seconds is skipped.
+The default is 90 seconds.
+(Zero or negative means "no timeout".)
.TP
.B $DEBUGINFOD_MAXTIME
This environment variable dictates how long the client will wait to
-\fIcomplete\fP the download a file found on a server in seconds. It is best
-used to ensure that a file is downloaded quickly or be rejected. The
-default is 0 (infinite time).
+\fIcomplete\fP the download a file found on a server in seconds.
+It is best used to ensure that a file is downloaded quickly or be rejected.
+The default is 0 (infinite time).
.TP
.B $DEBUGINFOD_MAXSIZE
This environment variable dictates the maximum size of a file to
-download in bytes. This is best used if the user would like to ensure
-only small files are downloaded. A value of 0 causes no consideration
-for size, and the client may attempt to download a file of any size.
+download in bytes.
+This is best used
+if the user would like to ensure only small files are downloaded.
+A value of 0 causes no consideration for size,
+and the client may attempt to download a file of any size.
The default is 0 (infinite size).
.TP
.B $DEBUGINFOD_HEADERS_FILE
This environment variable points to a file that supplies headers to
-outbound HTTP requests, one per line. The header lines shouldn't end with
-CRLF, unless that's the system newline convention. Whitespace-only lines
-are skipped.
+outbound HTTP requests, one per line.
+The header lines shouldn't end with CRLF,
+unless that's the system newline convention.
+Whitespace-only lines are skipped.
.TP
.B $DEBUGINFOD_IMA_CERT_PATH
This environment variable contains a list of absolute directory paths
holding X.509 certificates for RPM per-file IMA-verification.
-Alternate paths are separated by colons.
+Alternate paths are seperated by colons.
.SH CACHE
@@ -151,12 +160,12 @@ Deprecated cache directory, used only if
.TP
.B cache_clean_interval_s
This control file gives the interval between cache cleaning rounds, in
-seconds. The default is 86400, one day. 0 means "immediately".
+seconds. The default is 86,400, one day. 0 means "immediately".
.TP
.B max_unused_age_s
This control file sets how long unaccessed debuginfo-related files
-are retained, in seconds. The default is 604800, one week. 0 means
+are retained, in seconds. The default is 604,800, one week. 0 means
"immediately".
.TP
@@ -172,6 +181,9 @@ immediately".
.B metadata_retention_s
This control file sets how long to remember the results of a metadata
query. New queries for the same artifacts within this time window are
-short-circuited (repeating the same results). This accelerates
-queries that probably would probably have the same results. The
-default is 3600, 1 hour. 0 means "do not retain".
+short-circuited
+(repeating the same results).
+This accelerates queries
+that probably would probably have the same results.
+The default is 3600, 1 hour.
+0 means "do not retain".
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)
-.-
