From 4f5e52c2d3c8aa85d37fa067b7655c700ed5de37 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Thu, 7 Apr 2016 14:55:34 -0400 Subject: [PATCH] Add a basic manpage Commonly required for packaging. --- Makefile.am | 1 + configure.ac | 18 +++++++++++ man/Makefile-man.am | 47 +++++++++++++++++++++++++++ man/git-evtag.xml | 77 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 143 insertions(+) create mode 100644 man/Makefile-man.am create mode 100644 man/git-evtag.xml diff --git a/Makefile.am b/Makefile.am index b685553..1fa3880 100644 --- a/Makefile.am +++ b/Makefile.am @@ -35,6 +35,7 @@ typelibdir = $(pkglibdir)/girepository-1.0 typelib_DATA = $(gir_DATA:.gir=.typelib) include src/Makefile-git-evtag.am +include man/Makefile-man.am include rust/Makefile-inc.am include tests/Makefile-tests.am diff --git a/configure.ac b/configure.ac index 6227b1b..7128328 100644 --- a/configure.ac +++ b/configure.ac @@ -36,6 +36,23 @@ LIBS=$BUILDDEP_LIBGIT_GLIB_LIBS AC_CHECK_FUNCS(git_libgit2_init) LIBS=$save_LIBS +AC_ARG_ENABLE(man, + [AS_HELP_STRING([--enable-man], + [generate man pages [default=auto]])],, + enable_man=maybe) + +AS_IF([test "$enable_man" != no], [ + AC_PATH_PROG([XSLTPROC], [xsltproc]) + AS_IF([test -z "$XSLTPROC"], [ + AS_IF([test "$enable_man" = yes], [ + AC_MSG_ERROR([xsltproc is required for --enable-man]) + ]) + enable_man=no + ]) + enable_man=yes +]) +AM_CONDITIONAL(ENABLE_MAN, test "$enable_man" != no) + AC_ARG_ENABLE(rust, [AS_HELP_STRING([--enable-rust], [Compile Rust version [default=no]])],, @@ -66,6 +83,7 @@ AC_OUTPUT echo " $PACKAGE $VERSION + man pages (xsltproc): $enable_man installed tests: $enable_installed_tests Rust implementation: $enable_rust " diff --git a/man/Makefile-man.am b/man/Makefile-man.am new file mode 100644 index 0000000..9dd67a3 --- /dev/null +++ b/man/Makefile-man.am @@ -0,0 +1,47 @@ +# Makefile for man/ +# +# Copyright (C) 2016 Colin Walters +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the +# Free Software Foundation, Inc., 59 Temple Place - Suite 330, +# Boston, MA 02111-1307, USA. + +if ENABLE_MAN + +man1_files = git-evtag.1 + +man1_MANS = $(addprefix man/,$(man1_files)) + +EXTRA_DIST += $(man1_MANS) $(man5_MANS) + +XSLT_STYLESHEET = http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl + +XSLTPROC_FLAGS = \ + --nonet \ + --stringparam man.output.quietly 1 \ + --stringparam funcsynopsis.style ansi \ + --stringparam man.th.extra1.suppress 1 \ + --stringparam man.authors.section.enabled 0 \ + --stringparam man.copyright.section.enabled 0 + +XSLTPROC_MAN = $(XSLTPROC) $(XSLTPROC_FLAGS) + +%.1: %.xml + $(AM_V_GEN) $(XSLTPROC_MAN) --output $@ $(XSLT_STYLESHEET) $< + +CLEANFILES += \ + $(man1_MANS) \ + $(NULL) + +endif diff --git a/man/git-evtag.xml b/man/git-evtag.xml new file mode 100644 index 0000000..a1a9c6a --- /dev/null +++ b/man/git-evtag.xml @@ -0,0 +1,77 @@ + + + + + + + + + git-evtag + git-evtag + + + + Developer + Colin + Walters + walters@verbum.org + + + + + + git-evtag + 1 + + + + git-evtag + Sign a git commit with extended checksums + + + + + git evtag sign OPTIONS TAGNAME + + + git evtag verify OPTIONS TAGNAME + + + + + Description + + + While git can use GPG to sign tags and commits, it only + covers a commit object, which is subject to SHA1 weaknesses. + This tool uses SHA512 across the entire content of a tag, + creating a stronger level of assurance. + + + + + Options + + + See the subcommand help, e.g. git-evtag sign --help. + + +