[Pkg-rust-maintainers] Bug#1092815: sqv.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sat Jan 11 22:47:31 GMT 2025
Package: sqv
Version: 1.2.1-5
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?
an.tmac:<stdin>:4: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
* 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 sqv depends on:
ii libc6 2.40-4
ii libgcc-s1 14.2.0-12
ii libgmp10 2:6.3.0+dfsg-3
ii libhogweed6t64 3.10-1+b1
ii libnettle8t64 3.10-1+b1
sqv recommends no packages.
sqv suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is sqv.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 sqv.1": (shortened list)
4 input text line longer than 80 bytes
2 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z sqv.1": (shortened list)
1 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
39:TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
-.-.
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 "\&".
16:Consider signatures created after TIMESTAMP as invalid. If a date is given, 23:59:59 is used for the time. [default: now]
19:Consider signatures created before TIMESTAMP as invalid. If a date is given, 00:00:00 is used for the time. [default: no constraint]
39:TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
-.-.
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 3, length 92
.TH sqv 1 "sqv 1.2.1 (sequoia-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))"
Line 7, length 228
\fBsqv\fR <\fB\-\-keyring\fR> [\fB\-\-not\-after\fR] [\fB\-\-not\-before\fR] [\fB\-n\fR|\fB\-\-signatures\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fISIG\-FILE\fR> <\fIFILE\fR>
Line 16, length 121
Consider signatures created after TIMESTAMP as invalid. If a date is given, 23:59:59 is used for the time. [default: now]
Line 19, length 132
Consider signatures created before TIMESTAMP as invalid. If a date is given, 00:00:00 is used for the time. [default: no constraint]
Line 39, length 238
TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
Line 41, length 325
By default, sqv configures the cryptographic policy using /etc/crypto\-policies/back\-ends/sequoia.config. That can be overwritten by setting the SEQUOIA_CRYPTO_POLICY environment variable to an alternate file. The path must be absolute. The file\*(Aqs format is described here: <https://docs.rs/sequoia\-policy\-config/>.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
sqv.1:3:.TH sqv 1 "sqv 1.2.1 (sequoia-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))"
sqv.1:39:TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
sqv.1:43:v1.2.1 (sequoia\-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))
-.-.
Put a subordinate sentence (after a comma) on a new line.
3:.TH sqv 1 "sqv 1.2.1 (sequoia-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))"
16:Consider signatures created after TIMESTAMP as invalid. If a date is given, 23:59:59 is used for the time. [default: now]
19:Consider signatures created before TIMESTAMP as invalid. If a date is given, 00:00:00 is used for the time. [default: no constraint]
39:TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
41:By default, sqv configures the cryptographic policy using /etc/crypto\-policies/back\-ends/sequoia.config. That can be overwritten by setting the SEQUOIA_CRYPTO_POLICY environment variable to an alternate file. The path must be absolute. The file\*(Aqs format is described here: <https://docs.rs/sequoia\-policy\-config/>.
43:v1.2.1 (sequoia\-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
an.tmac:<stdin>:3: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:7: warning: trailing space in the line
-------------- next part --------------
--- sqv.1 2025-01-11 22:13:13.832643558 +0000
+++ sqv.1.new 2025-01-11 22:42:08.945703509 +0000
@@ -1,10 +1,14 @@
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
-.TH sqv 1 "sqv 1.2.1 (sequoia-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))"
+.TH sqv 1 "sqv 1.2.1 (sequoia-openpgp 1.21.2, \
+using Nettle 3.10 (Cv448: true, OCB: true))"
.SH NAME
sqv \- sqv is a command\-line OpenPGP signature verification tool
.SH SYNOPSIS
-\fBsqv\fR <\fB\-\-keyring\fR> [\fB\-\-not\-after\fR] [\fB\-\-not\-before\fR] [\fB\-n\fR|\fB\-\-signatures\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fISIG\-FILE\fR> <\fIFILE\fR>
+\fBsqv\fR <\fB\-\-keyring\fR> [\fB\-\-not\-after\fR] [\fB\-\-not\-before\fR]
+[\fB\-n\fR|\fB\-\-signatures\fR] [\fB\-v\fR|\fB\-\-verbose\fR]
+[\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fISIG\-FILE\fR>
+<\fIFILE\fR>
.SH DESCRIPTION
sqv is a command\-line OpenPGP signature verification tool
.SH OPTIONS
@@ -13,10 +17,16 @@ sqv is a command\-line OpenPGP signature
A keyring
.TP
\fB\-\-not\-after\fR=\fITIMESTAMP\fR
-Consider signatures created after TIMESTAMP as invalid. If a date is given, 23:59:59 is used for the time. [default: now]
+Consider signatures created after TIMESTAMP as invalid.
+If a date is given,
+23:59:59 is used for the time.
+[default: now]
.TP
\fB\-\-not\-before\fR=\fITIMESTAMP\fR
-Consider signatures created before TIMESTAMP as invalid. If a date is given, 00:00:00 is used for the time. [default: no constraint]
+Consider signatures created before TIMESTAMP as invalid.
+If a date is given,
+00:00:00 is used for the time.
+[default: no constraint]
.TP
\fB\-n\fR, \fB\-\-signatures\fR=\fIN\fR [default: 1]
The number of valid signatures to return success
@@ -36,8 +46,22 @@ File containing the detached signature
<\fIFILE\fR>
File to verify
.SH EXTRA
-TIMESTAMPs must be given in ISO 8601 format (e.g. \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq, \*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq, ...). If no timezone is specified, UTC is assumed.
+TIMESTAMPs must be given in ISO 8601 format
+(e.g., \*(Aq2017\-03\-04T13:25:35Z\*(Aq, \*(Aq2017\-03\-04T13:25\*(Aq,
+\*(Aq20170304T1325+0830\*(Aq, \*(Aq2017\-03\-04\*(Aq, \*(Aq2017031\*(Aq,
+\&...).
+If no timezone is specified, UTC is assumed.
-By default, sqv configures the cryptographic policy using /etc/crypto\-policies/back\-ends/sequoia.config. That can be overwritten by setting the SEQUOIA_CRYPTO_POLICY environment variable to an alternate file. The path must be absolute. The file\*(Aqs format is described here: <https://docs.rs/sequoia\-policy\-config/>.
+By default,
+sqv configures the cryptographic policy using
+/etc/crypto\-policies/back\-ends/sequoia.config.
+That can be overwritten by setting the SEQUOIA_CRYPTO_POLICY environment
+variable to an alternate file.
+The path must be absolute.
+The file\*(Aqs format is described here:
+<https://docs.rs/sequoia\-policy\-config/>.
.SH VERSION
-v1.2.1 (sequoia\-openpgp 1.21.2, using Nettle 3.10 (Cv448: true, OCB: true))
+v1.2.1
+(sequoia\-openpgp 1.21.2,
+using Nettle 3.10
+(Cv448: true, OCB: true))
More information about the Pkg-rust-maintainers
mailing list