gitstats: Add a description about the diff module
[git-stats.git] / doc / diff.txt
blob68cdd5cc2407e757ddcdcff05e15e6fdf118fced
1 syntax: stats.py diff <options>
3 The purpose of the diff module is to gather statistics
4 about diffs, or related to diffs.
6 Currently the available metrics in the diff module are the
7 following:
8 * Determine whether two commit diffs are equal, optionally
9   checking whether they are reverts instead. It is also
10   possible to just look at what lines were changed (and
11   ignore the actual changes).
13 * Find all commits that are reverted by the specified
14   commit by first retrieving the touched files, and then
15   examining all the commits that that touch the same files.
17 It also defines the following auxillery functions:
18 * Parse a raw commit diff and store it on a hunk-by-hunk
19   basis so that later on it can be examined more carefully
20   by other tools. Line numbers are optionally included so
21   that one can use those. For example, by comparing all the
22   added hunks with the deleted hunks of a second commit,
23   and vise versa, one can check for (partial) reverts.