浏览代码

Document linear_linestats and project_name options.

Heikki Hokkanen 13 年前
父节点
当前提交
e6b3058337
共有 1 个文件被更改,包括 15 次插入0 次删除
  1. 15
    0
      doc/gitstats.pod

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

30
 
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.
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
 =item max_authors
44
 =item max_authors
34
 
45
 
35
 How many authors to show in the list of authors.
46
 How many authors to show in the list of authors.
42
 
53
 
43
 Maximum file extension length.
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
 =item style
60
 =item style
46
 
61
 
47
 CSS stylesheet to use.
62
 CSS stylesheet to use.