doc/gitstats.pod

   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. Currently HTML is the only output format.
  14
  15 =head1 OPTIONS
  16
  17 -c option=value
  18
  19 Override a default configuration value. Defaults can be seen by running B<gitstats> without parameters.
  20
  21 =head2 Values:
  22
  23 =over
  24
  25 =item authors_top
  26
  27 How many top authors to show.
  28
  29 =item commit_begin, commit_end
  30
  31 Specify a commit range to generate statistics from. You can specify only commit_end limit statistics to a certain commit or another branch.
  32
  33 =item linear_linestats
  34
  35 When enabled, the lines of code statistics are collected from linear history.
  36 The downside is that commits of long feature branches appear only at the point
  37 where a merge commit is made.
  38
  39 If disabled (old behaviour), the problem is that if two branches contain the
  40 same changes (for example, removal of same lines), the statistics get skewed.
  41
  42 Defaults to on.
  43
  44 =item max_authors
  45
  46 How many authors to show in the list of authors.
  47
  48 =item max_domains
  49
  50 How many domains to show in domains by commits.
  51
  52 =item max_ext_length
  53
  54 Maximum file extension length.
  55
  56 =item processes
  57
  58 Number of concurrent processes to use when extracting git repository data.
  59
  60 =item project_name
  61
  62 Project name to show on the generated pages. Default is to use basename of the repository directory.
  63
  64 =item style
  65
  66 CSS stylesheet to use.
  67
  68 =back
  69
  70 =head1 FAQ
  71
  72 Q: How do I generate statistics of a non-master branch?
  73
  74 A: Use C<-c commit_end=web> parameter.
  75
  76 Q: I have files in my git repository that I would like to exclude from the statistics, how do I do that?
  77
  78 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.
  79
  80 =head1 EXAMPLES
  81
  82 =over
  83
  84 =item Generates statistics from a git repository in C<foo> and outputs the result in a directory C<foo_stats>:
  85
  86   gitstats foo foo_stats
  87
  88 =item As above, but only analyzes the last 10 commits:
  89
  90   gitstats -c commit_begin='HEAD~10' foo foo_stats
  91
  92 =back
  93
  94 =head1 AUTHORS
  95
  96 B<gitstats> was written by Heikki Hokkanen and others.
  97
  98 See the git repository at http://repo.or.cz/w/gitstats.git for an up-to-date full list of contributors.
  99
 100 =head1 WWW
 101
 102 http://gitstats.sourceforge.net/
 103
 104 =head1 SEE ALSO
 105
 106 L<git(1)>
 107