Page MenuHome GnuPG

gpg-check-pattern.1 in Debian generates warnings from test-groff
Closed, ResolvedPublic

Description

Over on https://bugs.debian.org/900247, Bjarni Ingi Gislason reports:

Warning from "groff":

<gpg-check-pattern.1>:19 (macro BR): only 1 argument, but more are expected

Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z

[ "test-groff" is a developmental version of "groff" ]

Summary of changes:

Use correct font for "options" (denotes variable text)

Split long lines (> 80) (and make only the first word bold)

Change a two-fonts macro to an one-font macro for a singular argument

Details:

Test nr. 16:

Use the correct macro for the font change of one argument.
Split a punctuation mark from the only argument if one is there

19:.BR \-\-check

Test nr. 42:

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause.

gpg-check-pattern.1: line 12 length 90
.B gpg\-check\-pattern checks a passphrase given on stdin against a specified patternfile.

Patch:
--- gpg-check-pattern.1	2018-02-22 22:20:18.000000000 +0000
+++ gpg-check-pattern.1.new	2018-05-28 00:57:21.000000000 +0000
@@ -5,18 +5,19 @@ gpg-check-pattern \- Check a passphrase
 
 .SH SYNOPSIS
 .B gpg\-check\-pattern
-.RB [ options ]
+.RI [ options ]
 .I patternfile
 
 .SH DESCRIPTION
-.B gpg\-check\-pattern checks a passphrase given on stdin against a specified patternfile.
+.B gpg\-check\-pattern
+checks a passphrase given on stdin against a specified patternfile.
 
 .SH OPTIONS
 .TP
 .BR \-v ", " \-\-verbose
 Produce verbose output
 .TP
-.BR \-\-check
+.B \-\-check
 run only a syntax check on the patternfile
 .TP
 .BR \-0 ",  " \-\-null

Details

External Link
https://bugs.debian.org/900247
Version
1.31

Revisions and Commits

Event Timeline

werner triaged this task as Normal priority.Jun 18 2018, 9:21 PM
werner added a subscriber: werner.

Thanks for forwarding.

gniibe renamed this task from nroff created by yat2m generates warnings from test-groff to gpg-check-pattern.1 in Debian generates warnings from test-groff .Jun 20 2018, 10:39 AM
gniibe edited projects, added gnupg, Debian; removed gpgrt.

We should include the man page then in texi format into tools.texi

gniibe claimed this task.

I added the section in tools.texi. Closing.