Package: zstd
Version: 1.5.7+dfsg-3
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 ":
tbl:"<stdin>:7: error: invalid column classifier '\'
tbl:"<stdin>:7: error: giving up on this table region
an.tmac:<stdin>:8: warning: tbl preprocessor failed, or it or soelim was not
run; table(s) likely not rendered (TE macro called with TW register undefined)
* 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.17.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 zstd depends on:
ii libc6 2.42-7
ii libgcc-s1 15.2.0-12
ii liblz4-1 1.10.0-6
ii liblzma5 5.8.2-1
ii libstdc++6 15.2.0-12
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b2
zstd recommends no packages.
zstd suggests no packages.
-- no debconf information
Input file is zstd.1
Output from "mandoc -T lint zstd.1": (shortened list)
1 ERROR: invalid character in tbl layout: B
1 ERROR: invalid character in tbl layout: O
3 ERROR: invalid character in tbl layout: [
12 ERROR: invalid character in tbl layout: \
1 ERROR: invalid character in tbl layout: f
1 ERROR: invalid character in tbl layout: o
1 ERROR: invalid character in tbl layout: z
1 ERROR: tbl without any data cells
65 STYLE: input text line longer than 80 bytes:
1 WARNING: skipping paragraph macro: sp after SH
1 WARNING: tbl line starts with span
1 WARNING: unknown font, skipping request: TS FILE\fR]
1 WARNING: unknown font, skipping request: TS FILE\fR] [\-o
\fIOUTPUT\-FILE\fR]
1 WARNING: unknown font, skipping request: TS fIINPUT\-FILE\fR] [\-o
\fIOUTPUT\-FILE\fR]
1 WARNING: unknown font, skipping request: TS fIOPTIONS\fR] [\-
\fIINPUT\-FILE\fR] [\-o \fIOUTPUT\-FILE\fR]
1 WARNING: unknown font, skipping request: TS fIOUTPUT\-FILE\fR]
1 WARNING: unknown font, skipping request: TS fR]
1 WARNING: unknown font, skipping request: TS fR] [\-
\fIINPUT\-FILE\fR] [\-o \fIOUTPUT\-FILE\fR]
1 WARNING: unknown font, skipping request: TS fR] [\-o \fIOUTPUT\-FILE\fR]
-.-.
Output from
test-nroff -mandoc -t -ww -z zstd.1: (shortened list)
1 giving up on this table region
1 invalid column classifier '\'
1 tbl preprocessor failed, or it or soelim was not run; table(s) likely
not rendered (TE macro called with TW register undefined)
-.-.
Input file is zstd.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.
zstd.1:72:\fB\-#\fR: selects \fB#\fR compression level [1\-19] (default: 3)\.
Higher compression levels \fIgenerally\fR produce higher compression ratio at
the expense of speed and memory\. A rough rule of thumb is that compression
speed is expected to be divided by 2 every 2 levels\. Technically, each level
is mapped to a set of advanced parameters (that can also be modified
individually, see below)\. Because the compressor's behavior highly depends on
the content to compress, there's no guarantee of a smooth progression from one
level to another\.
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.
285 \fB\-\-zstd\fR=wlog=23,clog=23,hlog=22,slog=6,mml=3,tlen=48,strat=6
341 \fB\-\-train\-fastcover[=k#,d=#,f=#,steps=#,split=#,accel=#]\fR
-.-.
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"
[List of affected lines removed.]
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Longest line is number 323 with 874 characters
Selects segments of size \fIk\fR with highest score to put in the dictionary\.
The score of a segment is computed by the sum of the frequencies of all the
subsegments of size \fId\fR\. Generally \fId\fR should be in the range [6, 8],
occasionally up to 16, but the algorithm will run faster with d <= \fI8\fR\.
Good values for \fIk\fR vary widely based on the input data, but a safe range
is [2 * \fId\fR, 2000]\. If \fIsplit\fR is 100, all input samples are used for
both training and testing to find optimal \fId\fR and \fIk\fR to build
dictionary\. Supports multithreading if \fBzstd\fR is compiled with threading
support\. Having \fIshrink\fR enabled takes a truncated dictionary of minimum
size and doubles in size until compression ratio of the truncated dictionary is
at most \fIshrinkDictMaxRegression%\fR worse than the compression ratio of the
largest dictionary\.
-.-.
Remove reverse slash (\) in front of a period (.) that is to be printed
as such, and can not come a control character in the first column of a line.
Use "\&" to protect the period to avoid that.
This is a sign, that the man page was transformed from another source
file with a program, whose name is NOT mentioned in a comment.
[List of affected lines is removed.]
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-.
Use a character "\(->" instead of plain "->" or "\->", if not typeset with
a constant width font.
382:\fBOutput Format:\fR CompressionLevel#Filename: InputSize \-> OutputSize
(CompressionRatio), CompressionSpeed, DecompressionSpeed
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
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.
zstd.1:1:.TH "ZSTD" "1" "October 2024" "zstd 1.5.6" "User Commands"
zstd.1:2:.SH "NAME"
zstd.1:4:.SH "SYNOPSIS"
zstd.1:15:.SH "DESCRIPTION"
zstd.1:19:.IP "\(bu" 4
zstd.1:21:.IP "\(bu" 4
zstd.1:23:.IP "\(bu" 4
zstd.1:25:.IP "\(bu" 4
zstd.1:27:.IP "\(bu" 4
zstd.1:34:.IP "\(bu" 4
zstd.1:36:.IP "\(bu" 4
zstd.1:41:.SH "OPTIONS"
zstd.1:71:.IP "\(bu" 4
zstd.1:73:.IP "\(bu" 4
zstd.1:75:.IP "\(bu" 4
zstd.1:77:.IP "\(bu" 4
zstd.1:79:.IP "\(bu" 4
zstd.1:85:.IP "\(bu" 4
zstd.1:87:.IP "\(bu" 4
zstd.1:91:.IP "\(bu" 4
zstd.1:95:.IP "\(bu" 4
zstd.1:97:.IP "\(bu" 4
zstd.1:107:.IP "\(bu" 4
zstd.1:109:.IP "\(bu" 4
zstd.1:111:.IP "\(bu" 4
zstd.1:113:.IP "\(bu" 4
zstd.1:115:.IP "\(bu" 4
zstd.1:121:.IP "\(bu" 4
zstd.1:123:.IP "\(bu" 4
zstd.1:125:.IP "\(bu" 4
zstd.1:127:.IP "\(bu" 4
zstd.1:129:.IP "\(bu" 4
zstd.1:131:.IP "\(bu" 4
zstd.1:133:.IP "\(bu" 4
zstd.1:135:.IP "\(bu" 4
zstd.1:137:.IP "\(bu" 4
zstd.1:139:.IP "\(bu" 4
zstd.1:141:.IP "\(bu" 4
zstd.1:143:.IP "\(bu" 4
zstd.1:145:.IP "\(bu" 4
zstd.1:147:.IP "\(bu" 4
zstd.1:151:.IP "\(bu" 4
zstd.1:153:.IP "\(bu" 4
zstd.1:155:.IP "\(bu" 4
zstd.1:157:.IP "\(bu" 4
zstd.1:159:.IP "\(bu" 4
zstd.1:161:.IP "\(bu" 4
zstd.1:163:.IP "\(bu" 4
zstd.1:165:.IP "\(bu" 4
zstd.1:167:.IP "\(bu" 4
zstd.1:188:.SS "\-\-zstd[=options]:"
zstd.1:282:.SS "Example"
zstd.1:286:.SS "\-B#:"
zstd.1:360:.SH "BENCHMARK"
zstd.1:362:.IP "\(bu" 4
zstd.1:364:.IP "\(bu" 4
zstd.1:366:.IP "\(bu" 4
zstd.1:368:.IP "\(bu" 4
zstd.1:370:.IP "\(bu" 4
zstd.1:372:.IP "\(bu" 4
zstd.1:374:.IP "\(bu" 4
zstd.1:376:.IP "\(bu" 4
zstd.1:389:.SH "BUGS"
zstd.1:391:.SH "AUTHOR"
-.-.
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.
388:The \fIzstandard\fR format is specified in Y\. Collet, "Zstandard
Compression and the 'application/zstd' Media Type",
https://www\.ietf\.org/rfc/rfc8878\.txt, Internet RFC 8878 (February 2021)\.
390:Report bugs at: https://github\.com/facebook/zstd/issues
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
tbl:"<stdin>:7: error: invalid column classifier '\'
tbl:"<stdin>:7: error: giving up on this table region
an.tmac:<stdin>:8: warning: tbl preprocessor failed, or it or soelim was not
run; table(s) likely not rendered (TE macro called with TW register undefined)
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- zstd.1 2026-01-11 17:46:16.813743262 +0000
+++ zstd.1.new 2026-01-11 18:06:15.219538826 +0000
@@ -2,10 +2,7 @@
.SH "NAME"
\fBzstd\fR \- zstd, zstdmt, unzstd, zstdcat \- Compress or decompress \.zst
files
.SH "SYNOPSIS"
-.TS
-allbox;
-\fBzstd\fR [\fIOPTIONS\fR] [\- \fIINPUT\-FILE\fR] [\-o \fIOUTPUT\-FILE\fR]
-.TE
+\fBzstd\fR [\fIOPTIONS\fR] [\fB\-\fR | \fIINPUT\-FILE\fR] [\fB\-o\fR
\fIOUTPUT\-FILE\fR]
.P
\fBzstdmt\fR is equivalent to \fBzstd \-T0\fR
.P
@@ -69,7 +66,7 @@ Use \fIFILES\fR as a training set to cre
Display information related to a zstd compressed file, such as size, ratio,
and checksum\. Some of these fields may not be available\. This command's
output can be augmented with the \fB\-v\fR modifier\.
.SS "Operation Modifiers"
.IP "\(bu" 4
-\fB\-#\fR: selects \fB#\fR compression level [1\-19] (default: 3)\. Higher
compression levels \fIgenerally\fR produce higher compression ratio at the
expense of speed and memory\. A rough rule of thumb is that compression speed
is expected to be divided by 2 every 2 levels\. Technically, each level is
mapped to a set of advanced parameters (that can also be modified individually,
see below)\. Because the compressor's behavior highly depends on the content to
compress, there's no guarantee of a smooth progression from one level to
another\.
+\fB\-#\fR: selects \fB#\fR compression level [1\(en19] (default: 3)\. Higher
compression levels \fIgenerally\fR produce higher compression ratio at the
expense of speed and memory\. A rough rule of thumb is that compression speed
is expected to be divided by 2 every 2 levels\. Technically, each level is
mapped to a set of advanced parameters (that can also be modified individually,
see below)\. Because the compressor's behavior highly depends on the content to
compress, there's no guarantee of a smooth progression from one level to
another\.
.IP "\(bu" 4
\fB\-\-ultra\fR: unlocks high compression levels 20+ (maximum 22), using a lot
more memory\. Note that decompression will also require more memory when using
these levels\.
.IP "\(bu" 4
@@ -205,14 +202,15 @@ Specify the maximum number of bits for a
.IP
Bigger hash tables cause fewer collisions which usually makes compression
faster, but requires more memory during compression\.
.IP
-The minimum \fIhlog\fR is 6 (64 entries / 256 B) and the maximum is 30 (1B
entries / 4 GiB)\.
+The minimum \fIhlog\fR is 6 (64 entries / 256 B) and the maximum is 30 (1 B
entries / 4 GiB)\.
.TP
\fBchainLog\fR=\fIclog\fR, \fBclog\fR=\fIclog\fR
Specify the maximum number of bits for the secondary search structure, whose
form depends on the selected \fBstrategy\fR\.
.IP
Higher numbers of bits increases the chance to find a match which usually
improves compression ratio\. It also slows down compression speed and increases
memory requirements for compression\. This option is ignored for the
\fBZSTD_fast\fR \fBstrategy\fR, which only has the primary hash table\.
.IP
-The minimum \fIclog\fR is 6 (64 entries / 256 B) and the maximum is 29 (512M
entries / 2 GiB) on 32\-bit platforms and 30 (1B entries / 4 GiB) on 64\-bit
platforms\.
+The minimum \fIclog\fR is 6 (64 entries / 256 B) and the maximum is 29 (512 M
entries / 2 GiB) on 32\-bit platforms and 30
+(1 B entries / 4 GiB) on 64\-bit platforms\.
.TP
\fBsearchLog\fR=\fIslog\fR, \fBslog\fR=\fIslog\fR
Specify the maximum number of searches in a hash chain or a binary tree using
logarithmic scale\.
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)
-.-
