Package: libnss3-tools
Version: 2:3.106-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 "groff -e ' $' <file>" to find 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>:50: warning: trailing space in the line
troff:<stdin>:65: warning: trailing space in the line
troff:<stdin>:70: 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.6-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.40-4
ii libnspr4 2:4.36-1
ii libnss3 2:3.106-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 nss-pp.1
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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
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.
Lines should thus be shorter.
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 -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 of 'diff -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)
-.-.
Output from "mandoc -T lint nss-pp.1": (shortened list)
6 input text line longer than 80 bytes
6 skipping paragraph macro
-.-.
Output from "test-groff -mandoc -t -ww -z nss-pp.1": (shortened list)
3 trailing space in the line
-.-.
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 abbreviation point as such by suffixing them with "\&".
37:This documentation is still work in progress\&. Please contribute to the
initial review in
76:NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla and Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
80:\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\&.
92: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.
Line 37, length 90
This documentation is still work in progress\&. Please contribute to the
initial review in
Line 41, length 109
\fBpp \fRpretty\-prints private and public key, certificate,
certificate\-request, pkcs7, pkcs12 or crl files
Line 46, length 121
specify the input, one of {private\-key | public\-key | certificate |
certificate\-request | pkcs7 | pkcs12 | crl | name}
Line 76, length 174
NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla and Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
Line 80, 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 87, length 115
The NSS tools were written and maintained by developers with Netscape, Red Hat,
Sun, Oracle, Mozilla, and Google\&.
Line 89, length 86
Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey
<dlackey@redhat\&.com>\&.
Line 92, 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/\&;.
-.-.
Show if docman-to-man created this
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
No need for "\&" to be in front of a period (.) if not at the beginning of
a line.
37:This documentation is still work in progress\&. Please contribute to the
initial review in
67:Use UTF\-8 (default is to show non\-ascii as \&.)
76:NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla and Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
82:Mailing lists: pki\-devel@redhat\&.com and pki\-users@redhat\&.com
89:Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey
<dlackey@redhat\&.com>\&.
92: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/\&;.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:50: warning: trailing space in the line
troff:<stdin>:65: warning: trailing space in the line
troff:<stdin>:70: warning: trailing space in the line
-.-.
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
--- nss-pp.1 2024-12-27 17:03:42.051109920 +0000
+++ nss-pp.1.new 2024-12-27 17:27:57.764253258 +0000
@@ -33,21 +33,32 @@ pp \- Prints certificates, keys, crls, a
.HP \w'\fBpp\ \-t\ type\ [\-a]\ [\-i\ input]\ [\-o\ output]\ [\-u]\ [\-w]\fR\
'u
\fBpp \-t type [\-a] [\-i input] [\-o output] [\-u] [\-w]\fR
.SH "STATUS"
-.PP
-This documentation is still work in progress\&. Please contribute to the
initial review in
+This documentation is still work in progress.
+Please contribute to the initial review in
\m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2
.SH "DESCRIPTION"
-.PP
-\fBpp \fRpretty\-prints private and public key, certificate,
certificate\-request, pkcs7, pkcs12 or crl files
+\fBpp \fRpretty\-prints private and public key,
+certificate,
+certificate\-request,
+pkcs7,
+pkcs12
+or crl files
.SH "OPTIONS"
-.PP
\fB\-t \fR \fItype\fR
.RS 4
-specify the input, one of {private\-key | public\-key | certificate |
certificate\-request | pkcs7 | pkcs12 | crl | name}
+specify the input,
+one of {private\-key |
+public\-key |
+certificate |
+certificate\-request |
+pkcs7 |
+pkcs12 |
+crl |
+name}
.sp
.RE
.PP
-\fB\-a \fR
+\fB\-a\fR
.RS 4
Input is in ascii encoded form (RFC1113)
.RE
@@ -62,34 +73,38 @@ Define an input file to use (default is
Define an output file to use (default is stdout)
.RE
.PP
-\fB\-u \fR
+\fB\-u\fR
.RS 4
Use UTF\-8 (default is to show non\-ascii as \&.)
.RE
.PP
-\fB\-w \fR
+\fB\-w\fR
.RS 4
Don\*(Aqt wrap long output lines
.RE
.SH "ADDITIONAL RESOURCES"
-.PP
-NSS is maintained in conjunction with PKI and security\-related projects
through Mozilla and Fedora\&. The most closely\-related project is Dogtag PKI,
with a project wiki at
-\m[blue]\fBPKI Wiki\fR\m[]\&\s-2\u[2]\d\s+2\&.
+NSS is maintained in conjunction with PKI
+and security\-related projects through Mozilla and Fedora.
+The most closely\-related project is Dogtag PKI,
+with a project wiki at \m[blue]\fBPKI Wiki\fR\m[]\&\s-2\u[2]\d\s+2.
.PP
For information specifically about NSS, the NSS project wiki is located at
-\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\&.
+\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.
.PP
-Mailing lists: pki\-devel@redhat\&.com and pki\-users@redhat\&.com
+Mailing lists: pki\[email protected] and pki\[email protected]
.PP
IRC: Freenode at #dogtag\-pki
.SH "AUTHORS"
+The NSS tools were written and maintained by developers with Netscape,
+Red Hat, Sun, Oracle, Mozilla, and Google.
.PP
-The NSS tools were written and maintained by developers with Netscape, Red
Hat, Sun, Oracle, Mozilla, and Google\&.
-.PP
-Authors: Elio Maldonado <emaldona@redhat\&.com>, Deon Lackey
<dlackey@redhat\&.com>\&.
+Authors: Elio Maldonado <[email protected]>,
+Deon Lackey <[email protected]>.
.SH "LICENSE"
-.PP
-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/\&;.
+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/.
.SH "NOTES"
.IP " 1." 4
Mozilla NSS bug 836477
