Pārlūkot izejas kodu

Add example invocations to documentation

Signed-off-by: Heikki Hokkanen <hoxu@users.sf.net>
Sven van Haastregt 13 gadus atpakaļ
vecāks
revīzija
084303928c
1 mainītis faili ar 14 papildinājumiem un 0 dzēšanām
  1. 14
    0
      doc/gitstats.pod

+ 14
- 0
doc/gitstats.pod Parādīt failu

@@ -73,6 +73,20 @@ Q: I have files in my git repository that I would like to exclude from the stati
73 73
 
74 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 90
 =head1 AUTHORS
77 91
 
78 92
 B<gitstats> was written by Heikki Hokkanen and others.