Package: libnss3-tools
Version: 2:3.114-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 -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 ":
troff:<stdin>:44: warning: trailing space in the 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: 13.0
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.38+deb13-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 libnss3-tools depends on:
ii libc6 2.41-12
ii libnspr4 2:4.36-1
ii libnss3 2:3.114-1
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
libnss3-tools recommends no packages.
libnss3-tools suggests no packages.
-- no debconf information
Input file is derdump.1
Output from "mandoc -T lint derdump.1": (shortened list)
5 STYLE: input text line longer than 80 bytes:
6 WARNING: skipping paragraph macro: PP after SH
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z derdump.1: (shortened list)
1 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Show if docman-to-man created this.
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
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"
37:This documentation is still work in progress\&. Please contribute to the
initial review in
60:NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla dn Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
64:\m[blue]\fBMozilla NSS site\fR\m[]\&\s-2\u[3]\d\s+2\&. The NSS site relates
directly to NSS code changes and releases\&.
73:Authors: Gerhardus Geldenhuis <gerhardus\&.geldenhuis@gmail\&.com>\&. Elio
Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>
76:Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy of the
MPL was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
-.-.
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 34, length 100
\fBderdump\fR [\fB\-r\fR] [\fB\-i\ \fR\fB\fIinput\-file\fR\fR] [\fB\-o\
\fR\fB\fIoutput\-file\fR\fR]
Line 37, length 90
This documentation is still work in progress\&. Please contribute to the
initial review in
Line 60, length 173
NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla dn Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
Line 64, length 120
\m[blue]\fBMozilla NSS site\fR\m[]\&\s-2\u[3]\d\s+2\&. The NSS site relates
directly to NSS code changes and releases\&.
Line 71, length 115
The NSS tools were written and maintained by developers with Netscape, Red Hat,
Sun, Oracle, Mozilla, and Google\&.
Line 73, length 144
Authors: Gerhardus Geldenhuis <gerhardus\&.geldenhuis@gmail\&.com>\&. Elio
Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>
Line 76, length 170
Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy of the MPL
was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
Longest line is number 60 with 173 characters
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
[List with affected lines removed.]
34:\fBderdump\fR [\fB\-r\fR] [\fB\-i\ \fR\fB\fIinput\-file\fR\fR] [\fB\-o\
\fR\fB\fIoutput\-file\fR\fR]
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
derdump.1:51:Define an input file to use (default is stdin)
derdump.1:56:Define an output file to use (default is stdout)\&.
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
37:This documentation is still work in progress\&. Please contribute to the
initial review in
56:Define an output file to use (default is stdout)\&.
60:NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla dn Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
61:\m[blue]\fBPKI Wiki\fR\m[]\&\s-2\u[2]\d\s+2\&.
64:\m[blue]\fBMozilla NSS site\fR\m[]\&\s-2\u[3]\d\s+2\&. The NSS site relates
directly to NSS code changes and releases\&.
66:Mailing lists: pki\-devel@redhat\&.com and pki\-users@redhat\&.com
71:The NSS tools were written and maintained by developers with Netscape, Red
Hat, Sun, Oracle, Mozilla, and Google\&.
73:Authors: Gerhardus Geldenhuis <gerhardus\&.geldenhuis@gmail\&.com>\&. Elio
Maldonado <emaldona@redhat\&.com>, Deon Lackey <dlackey@redhat\&.com>
76:Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy of the
MPL was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
derdump.1:37:This documentation is still work in progress\&. Please contribute
to the initial review in
derdump.1:60:NSS is maintained in conjunction with PKI and security\-related
projects through Mozilla dn Fedora\&. The most closely\-related project is
Dogtag PKI, with a project wiki at
derdump.1:64:\m[blue]\fBMozilla NSS site\fR\m[]\&\s-2\u[3]\d\s+2\&. The NSS
site relates directly to NSS code changes and releases\&.
derdump.1:73:Authors: Gerhardus Geldenhuis
<gerhardus\&.geldenhuis@gmail\&.com>\&. Elio Maldonado <emaldona@redhat\&.com>,
Deon Lackey <dlackey@redhat\&.com>
derdump.1:76:Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy
of the MPL was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
-.-.
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.
derdump.1:3:.\" Author: [see the "Authors" section]
derdump.1:10:.TH "DERDUMP" "1" "19 May 2021" "nss-tools" "NSS Security Tools"
derdump.1:30:.SH "NAME"
derdump.1:32:.SH "SYNOPSIS"
derdump.1:35:.SH "STATUS"
derdump.1:39:.SH "DESCRIPTION"
derdump.1:42:.SH "OPTIONS"
derdump.1:69:.SH "AUTHORS"
derdump.1:74:.SH "LICENSE"
derdump.1:77:.SH "NOTES"
-.-.
Remove excessive "\&" when it has no functional purpose.
38:\m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2
61:\m[blue]\fBPKI Wiki\fR\m[]\&\s-2\u[2]\d\s+2\&.
64:\m[blue]\fBMozilla NSS site\fR\m[]\&\s-2\u[3]\d\s+2\&. The NSS site relates
directly to NSS code changes and releases\&.
-.-.
Use "\-" instead of "-" in web addresses.
16:.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.-.
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.
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
15:.\" http://bugs.debian.org/507673
16:.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
76:Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy of the
MPL was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
81:\%https://bugzilla.mozilla.org/show_bug.cgi?id=836477
86:\%http://pki.fedoraproject.org/wiki/
91:\%http://www.mozilla.org/projects/security/pki/nss/
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:44: warning: trailing space in the line
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- derdump.1 2025-08-13 23:01:08.885041995 +0000
+++ derdump.1.new 2025-08-13 23:01:24.268553121 +0000
@@ -41,19 +41,19 @@ This documentation is still work in prog
\fBderdump \fRdumps C\-sequence strings from a DER encode certificate file
.SH "OPTIONS"
.PP
-\fB\-r \fR
+\fB\-r\fR
.RS 4
For formatted items, dump raw bytes as well
.RE
.PP
-\fB\-i \fR \fIDER encoded file\fR
+\fB\-i\fR \fIDER encoded file\fR
.RS 4
Define an input file to use (default is stdin)
.RE
.PP
-\fB\-o \fR \fIoutput file\fR
+\fB\-o\fR \fIoutput file\fR
.RS 4
-Define an output file to use (default is stdout)\&.
+Define an output file to use (default is stdout).
.RE
.SH "ADDITIONAL RESOURCES"
.PP
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.
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)
-.-
