Browse Source

Document linear_linestats and project_name options.

Heikki Hokkanen 13 years ago
parent
commit
e6b3058337
1 changed files with 15 additions and 0 deletions
  1. 15
    0
      doc/gitstats.pod

+ 15
- 0
doc/gitstats.pod View File

@@ -30,6 +30,17 @@ How many top authors to show.
30 30
 
31 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 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
+
33 44
 =item max_authors
34 45
 
35 46
 How many authors to show in the list of authors.
@@ -42,6 +53,10 @@ How many domains to show in domains by commits.
42 53
 
43 54
 Maximum file extension length.
44 55
 
56
+=item project_name
57
+
58
+Project name to show on the generated pages. Default is to use basename of the repository directory.
59
+
45 60
 =item style
46 61
 
47 62
 CSS stylesheet to use.