浏览代码

Add example invocations to documentation

Signed-off-by: Heikki Hokkanen <hoxu@users.sf.net>
Sven van Haastregt 13 年前
父节点
当前提交
084303928c
共有 1 个文件被更改,包括 14 次插入0 次删除
  1. 14
    0
      doc/gitstats.pod

+ 14
- 0
doc/gitstats.pod 查看文件

73
 
73
 
74
 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.
74
 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.
75
 
75
 
76
+=head1 EXAMPLES
77
+
78
+=over
79
+
80
+=item Generates statistics from a git repository in C<foo> and outputs the result in a directory C<foo_stats>:
81
+
82
+  gitstats foo foo_stats
83
+
84
+=item As above, but only analyzes the last 10 commits:
85
+
86
+  gitstats -c commit_begin='HEAD~10' foo foo_stats
87
+
88
+=back
89
+
76
 =head1 AUTHORS
90
 =head1 AUTHORS
77
 
91
 
78
 B<gitstats> was written by Heikki Hokkanen and others.
92
 B<gitstats> was written by Heikki Hokkanen and others.