gitstats(1)

1GITSTATS(1)                      User Commands                     GITSTATS(1)
2
3
4

NAME

6       gitstats - git history statistics generator
7

SYNOPSIS

9       gitstats [options] <repository dir> <output dir>
10

DESCRIPTION

12       gitstats is a statistics generator for git(1) repositories. It examines
13       the repository and produces some interesting statistics from the
14       history of it. Currently HTML is the only output format.
15

OPTIONS

17       -c option=value
18
19       Override a default configuration value. Defaults can be seen by running
20       gitstats without parameters.
21
22   Values:
23       authors_top
24           How many top authors to show.
25
26       commit_begin, commit_end
27           Specify a commit range to generate statistics from. You can specify
28           only commit_end limit statistics to a certain commit or another
29           branch.
30
31       linear_linestats
32           When enabled, the lines of code statistics are collected from
33           linear history.  The downside is that commits of long feature
34           branches appear only at the point where a merge commit is made.
35
36           If disabled (old behaviour), the problem is that if two branches
37           contain the same changes (for example, removal of same lines), the
38           statistics get skewed.
39
40           Defaults to on.
41
42       max_authors
43           How many authors to show in the list of authors.
44
45       max_domains
46           How many domains to show in domains by commits.
47
48       max_ext_length
49           Maximum file extension length.
50
51       processes
52           Number of concurrent processes to use when extracting git
53           repository data.
54
55       project_name
56           Project name to show on the generated pages. Default is to use
57           basename of the repository directory.
58
59       start_date
60           Specify a starting date to pass with --since to git.
61
62       style
63           CSS stylesheet to use.
64

FAQ

66       Q: How do I generate statistics of a non-master branch?
67
68       A: Use "-c commit_end=web" parameter.
69
70       Q: I have files in my git repository that I would like to exclude from
71       the statistics, how do I do that?
72
73       A: At the moment the only way is to use git-filter-branch(1) to create
74       a temporary repository and generate the statistics from that.
75
76       Q: How do I merge author information when the same author has made
77       commits using different names or emails ?
78
79       A: Use git .mailmap feature described in MAPPING AUTHORS of
80       git-shortlog(1).
81

EXAMPLES

83       Generates statistics from a git repository in "foo" and outputs the
84       result in a directory "foo_stats":
85             gitstats foo foo_stats
86
87       As above, but only analyzes the last 10 commits:
88             gitstats -c commit_begin='HEAD~10' foo foo_stats
89

AUTHORS

91       gitstats was written by Heikki Hokkanen and others.
92
93       See the git repository at https://github.com/hoxu/gitstats for an up-
94       to-date full list of contributors.
95

WWW

97       http://gitstats.sourceforge.net/
98