ソースを参照

Add a simple manpage.

The manpage is in pod format, and pod2man can be used to convert it.
Heikki Hokkanen 15 年 前
コミット
70c7bd5ccc
共有2 個のファイルを変更した41 個の追加0 個の削除を含む
  1. 3
    0
      Makefile
  2. 38
    0
      doc/gitstats.pod

+ 3
- 0
Makefile ファイルの表示

@@ -28,4 +28,7 @@ release:
28 28
 	@tar --owner=0 --group=0 --transform 's!^!gitstats/!' --transform 's!gitstats.tmp!gitstats!' -zcf gitstats-$(VERSION).tar.gz gitstats.tmp $(RESOURCES) doc/ Makefile
29 29
 	@$(RM) gitstats.tmp
30 30
 
31
+man:
32
+	pod2man --center "User Commands" -r $(shell git rev-parse --short HEAD) doc/gitstats.pod > doc/gitstats.1
33
+
31 34
 .PHONY: all help install release

+ 38
- 0
doc/gitstats.pod ファイルの表示

@@ -0,0 +1,38 @@
1
+=encoding utf8
2
+
3
+=head1 NAME
4
+
5
+gitstats - git history statistics generator
6
+
7
+=head1 SYNOPSIS
8
+
9
+B<gitstats> [options] <repository dir> <output dir>
10
+
11
+=head1 DESCRIPTION
12
+
13
+B<gitstats> is a statistics generator for L<git(1)> repositories. It examines the repository and produces some interesting statistics from the history of it.
14
+
15
+=head1 FAQ
16
+
17
+Q: How do I generate statistics of a non-master branch?
18
+
19
+A: Use C<-c commit_end=web> parameter.
20
+
21
+Q: I have files in my git repository that I would like to exclude from the statistics, how do I do that?
22
+
23
+A: At the moment the only way is to use L<git-filter-branch(1)> to create a temporary repository and generate the statistics from that.
24
+
25
+=head1 AUTHORS
26
+
27
+B<gitstats> was written by Heikki Hokkanen and others.
28
+
29
+See the git repository at http://repo.or.cz/w/gitstats.git for an up-to-date full list of contributors.
30
+
31
+=head1 WWW
32
+
33
+http://gitstats.sourceforge.net/
34
+
35
+=head1 SEE ALSO
36
+
37
+L<git(1)>
38
+