Package: zlib1g-dev
Version: 1:1.3.dfsg+really1.3.1-1+b1
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?
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:41: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
* 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.11-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 zlib1g-dev depends on:
ii libc6-dev [libc-dev] 2.40-6
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
zlib1g-dev recommends no packages.
zlib1g-dev suggests no packages.
-- no debconf information
Output from "mandoc -T lint zlib.3": (shortened list)
1 input text line longer than 80 bytes: is built in to many ...
1 skipping paragraph macro: PP empty
-.-.
Output from "test-groff -mandoc -t -ww -z zlib.3": (shortened list)
2 Use macro '.I' for one argument or split argument.
2 .IR is for at least 2 arguments, got 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.
zlib.3:110:Copyright (C) 1995-2024 Jean-loup Gailly and Mark Adler
-.-.
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 "\&".
86:for the Jan. 1997 issue of Dr. Dobb's Journal;
123:claim that you wrote the original software. If you use this software
141:specifications were written by L. Peter Deutsch.
147:UNIX manual page by R. P. C. Rodgers,
148:U.S. National Library of Medicine (rodg...@nlm.nih.gov).
-.-.
Split a punctuation mark from a single argument for a two-font macro
41:.IR test/minigzip.c,
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:41: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
--- zlib.3 2025-02-05 21:04:17.994605527 +0000
+++ zlib.3.new 2025-02-05 21:12:06.717605731 +0000
@@ -38,9 +38,9 @@ The distribution source includes example
in the files
.I test/example.c
and
-.IR test/minigzip.c,
+.IR test/minigzip.c ,
as well as other examples in the
-.IR examples/
+.I examples/
directory.
.LP
Changes to this version are documented in the file
@@ -83,7 +83,7 @@ http://tools.ietf.org/html/rfc1952 (for
.LP
Mark Nelson wrote an article about
.I zlib
-for the Jan. 1997 issue of Dr. Dobb's Journal;
+for the Jan.\& 1997 issue of Dr.\& Dobb's Journal;
a copy of the article is available at:
.IP
http://marknelson.us/1997/01/01/zlib-engine/
@@ -107,7 +107,7 @@ or (for the Windows DLL version) to Gill
.SH AUTHORS AND LICENSE
Version 1.3.1
.LP
-Copyright (C) 1995-2024 Jean-loup Gailly and Mark Adler
+Copyright (C) 1995\(en2024 Jean-loup Gailly and Mark Adler
.LP
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
@@ -120,7 +120,8 @@ freely, subject to the following restric
.nr step 1 1
.IP \n[step]. 3
The origin of this software must not be misrepresented; you must not
-claim that you wrote the original software. If you use this software
+claim that you wrote the original software.
+If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
.IP \n+[step].
@@ -138,12 +139,12 @@ The deflate format used by
was defined by Phil Katz.
The deflate and
.I zlib
-specifications were written by L. Peter Deutsch.
+specifications were written by L.\& Peter Deutsch.
Thanks to all the people who reported problems and suggested various
improvements in
.IR zlib ;
who are too numerous to cite here.
.LP
-UNIX manual page by R. P. C. Rodgers,
-U.S. National Library of Medicine (rodg...@nlm.nih.gov).
+UNIX manual page by R.\& P.\& C.\& Rodgers,
+U.S.\& National Library of Medicine (rodg...@nlm.nih.gov).
.\" end of man page
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.
Not beginning each input sentence on a new line.
Line length 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)
-.-
