[Pkg-gnupg-commit] [gnupg2] 06/09: hand-craft the manpages upstream doesn't ship

Daniel Kahn Gillmor dkg at fifthhorseman.net
Fri Apr 1 16:20:27 UTC 2016


This is an automated email from the git hooks/post-receive script.

dkg pushed a commit to branch experimental
in repository gnupg2.

commit 3c0c7eb782602a1b8424c44fe9831f2a70c5ebfd
Author: Daniel Kahn Gillmor <dkg at fifthhorseman.net>
Date:   Thu Mar 31 21:46:06 2016 -0400

    hand-craft the manpages upstream doesn't ship
    
    This is the cleaner resolution, dropping help2man: it produces
    nicer-looking manpages; cross-compiling works; cross-compiling and
    building natively should produce reproducible code.
    
    The main remaining risk is that the manpages may get out of sync with
    upstream, if kbxutil or gpg-check-pattern sprout new features.  We
    should encourage upstream to document these tools anyway.
---
 debian/control             |  1 -
 debian/gpg-check-pattern.1 | 38 ++++++++++++++++++--------------
 debian/kbxutil.1           | 55 +++++++++++++++++++++++++---------------------
 debian/rules               |  5 -----
 4 files changed, 51 insertions(+), 48 deletions(-)

diff --git a/debian/control b/debian/control
index a86a979..45972e7 100644
--- a/debian/control
+++ b/debian/control
@@ -12,7 +12,6 @@ Build-Depends: automake,
                file,
                gettext,
                ghostscript,
-               help2man,
                libassuan-dev (>= 2.4.1),
                libbz2-dev,
                libcurl4-gnutls-dev,
diff --git a/debian/gpg-check-pattern.1 b/debian/gpg-check-pattern.1
index 1e80832..05dbc1e 100644
--- a/debian/gpg-check-pattern.1
+++ b/debian/gpg-check-pattern.1
@@ -1,31 +1,35 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
-.TH GPG-CHECK-PATTERN "1" "March 2016" "gpg-check-pattern (@GnuPG@) 2.1.11" "User Commands"
+.TH GPG-CHECK-PATTERN "1" "March 2016" "gpg-check-pattern (GnuPG) 2.1.11" "User Commands"
+
 .SH NAME
 gpg-check-pattern \- Check a passphrase on stdin against the patternfile
+
+.SH SYNOPSIS
+.B gpg\-check\-pattern
+.RB [ options ]
+.I patternfile
+
 .SH DESCRIPTION
-gpg\-check\-pattern (@GnuPG@) 2.1.11
-Copyright \(co 2016 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
-.PP
-Syntax: gpg\-check\-pattern [options] patternfile
-Check a passphrase given on stdin against the patternfile
+.B gpg\-check\-pattern checks a passphrase given on stdin against a specified patternfile.
+
 .SH OPTIONS
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
-verbose
+.BR \-v ", " \-\-verbose
+Produce verbose output
 .TP
-\fB\-\-check\fR
+.BR \-\-check
 run only a syntax check on the patternfile
 .TP
-\fB\-0\fR, \fB\-\-null\fR
+.BR \-0 ",  " \-\-null
 input is expected to be null delimited
 .PP
-Please report bugs to <http://bugs.gnupg.org>.
+Please report bugs to <https://bugs.gnupg.org>.
+
 .SH COPYRIGHT
 Copyright \(co 2016 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-.br
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
+
 This is free software: you are free to change and redistribute it.
 There is NO WARRANTY, to the extent permitted by law.
+
+This manpage was written by \fBDaniel Kahn Gillmor\fR for the Debian
+distribution (but may be used by others).
diff --git a/debian/kbxutil.1 b/debian/kbxutil.1
index 08eb517..52b338a 100644
--- a/debian/kbxutil.1
+++ b/debian/kbxutil.1
@@ -1,57 +1,62 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
 .TH KBXUTIL "1" "March 2016" "kbxutil (GnuPG) 2.1.11" "User Commands"
+
 .SH NAME
 kbxutil \- List, export, import Keybox data
+
+.SH SYNOPSIS
+.B kbxutil
+.RB [ OPTIONS ]
+.RB [ FILES ]
+
 .SH DESCRIPTION
-kbxutil (GnuPG) 2.1.11
-Copyright \(co 2016 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
-.PP
-Syntax: kbxutil [options] [files]
 List, export, import Keybox data
-.PP
-Commands:
+
+.SH COMMANDS
 .TP
-\fB\-\-stats\fR
+.B \-\-stats
 show key statistics
 .TP
-\fB\-\-import\-openpgp\fR
+.B \-\-import\-openpgp
 import OpenPGP keyblocks
 .TP
-\fB\-\-find\-dups\fR
+.B \-\-find\-dups
 find duplicates
 .TP
-\fB\-\-cut\fR
+.B \-\-cut
 export records
+
 .SH OPTIONS
 .TP
-\fB\-\-from\fR N
+.BI \-\-from " N"
 first record to export
 .TP
-\fB\-\-to\fR N
+.BI \-\-to " N"
 last record to export
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
+.BR \-v ", " \-\-verbose
 verbose
 .TP
-\fB\-q\fR, \fB\-\-quiet\fR
+.BR \-q ", " \-\-quiet
 be somewhat more quiet
 .TP
-\fB\-n\fR, \fB\-\-dry\-run\fR
+.BR \-n ", " \-\-dry\-run
 do not make any changes
 .TP
-\fB\-\-debug\fR
+.B \-\-debug
 set debugging flags
 .TP
-\fB\-\-debug\-all\fR
+.B \-\-debug\-all
 enable full debugging
-.PP
-Please report bugs to <http://bugs.gnupg.org>.
+
+.SH BUGS
+Please report bugs to <https://bugs.gnupg.org>.
+
 .SH COPYRIGHT
 Copyright \(co 2016 Free Software Foundation, Inc.
-License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-.br
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
+
 This is free software: you are free to change and redistribute it.
 There is NO WARRANTY, to the extent permitted by law.
+
+This manpage was written by \fBDaniel Kahn Gillmor\fR for the Debian
+distribution (but may be used by others).
diff --git a/debian/rules b/debian/rules
index 78c1d3c..f78b7ef 100755
--- a/debian/rules
+++ b/debian/rules
@@ -38,11 +38,6 @@ override_dh_auto_build-arch:
 	dh_auto_build --builddirectory=build-gpgv-udeb
 	ln build-gpgv-udeb/g10/gpgv2 build-gpgv-udeb/g10/gpgv
 	dh_auto_build --builddirectory=build
-	# try to re-generate manpages if we can do so (otherwise, ship the pre-generated ones):
-	help2man --no-info -n "List, export, import Keybox data" \
-		-o debian/kbxutil.1 build/kbx/kbxutil || true
-	help2man --no-info -n "Check a passphrase on stdin against the patternfile" \
-		-o debian/gpg-check-pattern.1 build/tools/gpg-check-pattern || true
 
 override_dh_auto_build-indep:
 	mkdir -p build-gpgv-win32

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gnupg2.git



More information about the Pkg-gnupg-commit mailing list