gitstats: Licensed GitStats under the Apache License, 2.0
[git-stats.git] / doc / gitstats-matcher.txt
blob6ab9d532acf06e4414123cb6a6f29c1dd8117782
1 syntax: stats.py matcher <options>
3 The purpose of the matcher module is to compare hunks
4 within one diff to one another, and determine whether there
5 is any code being moved around.
7 Currently the available metrics in the index module are the
8 following:
9 * Try to find a match between the hunks in one diff, so
10   that code moves can be detected. This makes use of the
11   'diff size calculation' described below.
13 It also defines the following auxiliary functions:
14 * Calculate the size of a diff, only counting the amount
15   of lines added, and the amount of lines deleted. This can
16   be used to determine a best 'interdiff' (the shortest one
17   is the best one), when searching for two hunks that are
18   moved around.