Package: libcrypt-dev
Version: 1:4.4.38-1
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 "grep -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>:61: warning [page 1, line 37, diversion '3tbd1,0', line 1]:
cannot break 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.20-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 libcrypt-dev depends on:
ii libcrypt1 1:4.4.38-1
libcrypt-dev recommends no packages.
libcrypt-dev suggests no packages.
-- no debconf information
Input file is crypt_preferred_method.3
Output from "mandoc -T lint crypt_preferred_method.3": (shortened list)
2 new sentence, new line
1 operating system explicitly specified: Os libxcrypt (NetBSD)
-.-.
Output from "test-nroff -mandoc -t -ww -z crypt_preferred_method.3": (shortened
list)
1 cannot break line
-.-.
Put a subordinate sentence (after a comma) on a new line.
crypt_preferred_method.3:25:method. If a preferred method is available, it is
the same as the
crypt_preferred_method.3:53:For an explanation of the terms used in this
section, see
-.-.
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.
crypt_preferred_method.3:10:.Os "libxcrypt"
crypt_preferred_method.3:20:.Fa "void"
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:61: warning [page 1, line 37, diversion '3tbd1,0', line 1]:
cannot break line
-.-.
Additionally:
Add the length of the output of request '.Nm' to the table to avoid a
warning.
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
10c10
< .Os "libxcrypt"
---
> .Os libxcrypt
20c20
< .Fa "void"
---
> .Fa void
25,26c25,27
< method. If a preferred method is available, it is the same as the
< one also used by the
---
> method.
> If a preferred method is available,
> it is the same as the one also used by the
33c34,35
< If no preferred hash method is available it is NULL. It
---
> If no preferred hash method is available it is NULL.
> It
53c55,56
< For an explanation of the terms used in this section, see
---
> For an explanation of the terms used in this section,
> see
58c61
< l l l.
---
> lw(22n) l l.
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 -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
-.-
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)
-.-
