From 70c7bd5ccc9cbae195728f120f3feebee1c96dc9 Mon Sep 17 00:00:00 2001 From: Heikki Hokkanen Date: Sat, 7 Aug 2010 10:06:55 +0300 Subject: [PATCH] Add a simple manpage. The manpage is in pod format, and pod2man can be used to convert it. --- Makefile | 3 +++ doc/gitstats.pod | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 doc/gitstats.pod diff --git a/Makefile b/Makefile index 7427419..740d5e5 100644 --- a/Makefile +++ b/Makefile @@ -28,4 +28,7 @@ release: @tar --owner=0 --group=0 --transform 's!^!gitstats/!' --transform 's!gitstats.tmp!gitstats!' -zcf gitstats-$(VERSION).tar.gz gitstats.tmp $(RESOURCES) doc/ Makefile @$(RM) gitstats.tmp +man: + pod2man --center "User Commands" -r $(shell git rev-parse --short HEAD) doc/gitstats.pod > doc/gitstats.1 + .PHONY: all help install release diff --git a/doc/gitstats.pod b/doc/gitstats.pod new file mode 100644 index 0000000..b60c391 --- /dev/null +++ b/doc/gitstats.pod @@ -0,0 +1,38 @@ +=encoding utf8 + +=head1 NAME + +gitstats - git history statistics generator + +=head1 SYNOPSIS + +B [options] + +=head1 DESCRIPTION + +B is a statistics generator for L repositories. It examines the repository and produces some interesting statistics from the history of it. + +=head1 FAQ + +Q: How do I generate statistics of a non-master branch? + +A: Use C<-c commit_end=web> parameter. + +Q: I have files in my git repository that I would like to exclude from the statistics, how do I do that? + +A: At the moment the only way is to use L to create a temporary repository and generate the statistics from that. + +=head1 AUTHORS + +B was written by Heikki Hokkanen and others. + +See the git repository at http://repo.or.cz/w/gitstats.git for an up-to-date full list of contributors. + +=head1 WWW + +http://gitstats.sourceforge.net/ + +=head1 SEE ALSO + +L + -- 2.11.4.GIT