Add the VirtualEmployer mechanism
[mining-tools:gitdm.git] / README
1 The code in this directory makes up the "git data miner," a simple hack
2 which attempts to figure things out from the revision history in a git
3 repository. 
4
5
6 INSTALLING GITDM
7
8 gitdm is a python script and doesn't need to be proper installed like other
9 normal programs. You just have to adjust your PATH variable, pointing it to
10 the directory of gitdm or alternatively create a symbolic link of the script
11 inside /usr/bin.
12
13 Before actually run gitdm you may want also to update the configuration file
14 (gitdm.config) with the needed information.
15
16
17 RUNNING GITDM
18
19 Run it like this:
20
21    git log -p -M [details] | gitdm [options]
22
23 The [details] tell git which changesets are of interest; the [options] can
24 be:
25
26         -a      If a patch contains signoff lines from both Andrew Morton 
27                 and Linus Torvalds, omit Linus's.
28
29         -b dir  Specify the base directory to fetch the configuration files.
30
31         -c file Specify the name of the gitdm configuration file.  
32                 By default, "./gitdm.config" is used.
33
34         -d      Omit the developer reports, giving employer information
35                 only. 
36
37         -D      Rather than create the usual statistics, create a 
38         file (datelc) providing lines changed per day, where the first column
39         displays the changes happened only on that day and the second sums
40         the day it happnened with the previous ones. This option is suitable
41         for feeding to a tool like gnuplot.
42
43         -h file Generate HTML output to the given file
44
45         -l num  Only list the top <num> entries in each report.
46
47         -o file Write text output to the given file (default is stdout).
48
49         -r pat  Only generate statistics for changes to files whose 
50                 name matches the given regular expression.
51
52         -s      Ignore Signed-off-by lines which match the author of 
53                 each patch.
54
55         -u      Group all unknown developers under the "(Unknown)"
56                 employer. 
57
58     -x file  Export raw statistics as CSV.
59
60     -w  Aggregate the data by weeks instead of months in the
61         CSV file when -x is used.
62
63         -z      Dump out the hacker database to "database.dump".
64
65 A typical command line used to generate the "who write 2.6.x" LWN articles
66 looks like:
67
68     git log -p -M v2.6.19..v2.6.20 | \
69         gitdm -u -s -a -o results -h results.html
70
71
72 CONFIGURATION FILE
73
74 The main purpose of the configuration file is to direct the mapping of
75 email addresses onto employers.  Please note that the config file parser is
76 exceptionally stupid and unrobust at this point, but it gets the job done.  
77
78 Blank lines and lines beginning with "#" are ignored.  Everything else
79 specifies a file with some sort of mapping:
80
81 EmailAliases file
82
83         Developers often post code under a number of different email
84         addresses, but it can be desirable to group them all together in
85         the statistics.  An EmailAliases file just contains a bunch of
86         lines of the form:
87
88                 alias@address  canonical@address
89
90         Any patches originating from alias@address will be treated as if
91         they had come from canonical@address.
92
93     It may happen that some people set their git user data in the
94     following form: "joe.hacker@acme.org <Joe Hacker>". The 
95     "Joe Hacker" is then considered as the email... but gitdm says
96     it is a "Funky" email. An alias line in the following form can
97     be used to alias these commits aliased to the correct email
98     address:
99
100         "Joe Hacker" joe.hacker@acme.org
101
102
103 EmailMap file
104
105         Map email addresses onto employers.  These files contain lines
106         like:
107
108                 [user@]domain  employer  [< yyyy-mm-dd]
109
110         If the "user@" portion is missing, all email from the given domain
111         will be treated as being associated with the given employer.  If a
112         date is provided, the entry is only valid up to that date;
113         otherwise it is considered valid into the indefinite future.  This
114         feature can be useful for properly tracking developers' work when
115         they change employers but do not change email addresses.
116
117
118 GroupMap file employer
119
120         This is a variant of EmailMap provided for convenience; it contains
121         email addresses only, all of which are associated with the given
122         employer.
123
124 VirtualEmployer name
125     nn% employer1
126     ...
127 end
128
129         This construct (which appears in the main configuration file)
130         allows causes the creation of a fake employer with the given
131         "name".  It directs that any contributions attributed to that
132         employer should be split to other (real) employers using the given
133         percentages.  The functionality works, but is primitive - there is,
134         for example, no check to ensure that the percentages add up to
135         something rational.
136
137
138 OTHER TOOLS
139
140 A few other tools have been added to this repository:
141
142   treeplot
143         Reads a set of commits, then generates a graphviz file charting the
144         flow of patches into the mainline.  Needs to be smarter, but, then,
145         so does everything else in this directory.
146
147   findoldfiles
148         Simple brute-force crawler which outputs the names of any files
149         which have not been touched since the original (kernel) commit.
150
151   committags
152         I needed to be able to quickly associate a given commit with the
153         major release which contains it.  First attempt used 
154         "git tags --contains="; after it ran for a solid week, I concluded
155         there must be a better way.  This tool just reads through the repo,
156         remembering tags, and creating a Python dictionary containing the
157         association.  The result is an ugly 10mb pickle file, but, even so,
158         it's still a better way.
159
160   linetags
161         Crawls through a directory hierarchy, counting how many lines of
162         code are associated with each major release.  Needs the pickle file
163         from committags to get the job done.
164
165
166 NOTES AND CREDITS
167
168 Gitdm was written by Jonathan Corbet; many useful contributions have come
169 from Greg Kroah-Hartman.
170
171 Please note that this tool is provided in the hope that it will be useful,
172 but it is not put forward as an example of excellence in design or
173 implementation.  Hacking on gitdm tends to stop the moment it performs
174 whatever task is required of it at the moment.  Patches to make it less
175 hacky, less ugly, and more robust are welcome.
176
177 Jonathan Corbet
178 corbet@lwn.net