From 463240a61a86c6c2a654c1e62dc9c9673f12fc80 Mon Sep 17 00:00:00 2001 From: Sverre Rabbelier Date: Mon, 28 Jul 2008 14:49:28 +0200 Subject: [PATCH] gitstats: Add a description about the matcher module This briefly lists the most useful functions it exports, it should later be made to include a more detailed description of what metrics the user should expect this subcommand to contain. --- doc/matcher.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/matcher.txt diff --git a/doc/matcher.txt b/doc/matcher.txt new file mode 100644 index 0000000..682ffbb --- /dev/null +++ b/doc/matcher.txt @@ -0,0 +1,19 @@ +syntax: stats.py matcher + +The purpose of the matcher module is to compare hunks +within one diff to one another, and determine whether there +is any code being moved around. + +Currently the available metrics in the index module are the +following: +* Try to find a match between the hunks in one diff, so + that code moves can be detected. This makes use of the + 'diff size calculation' described below. + +It also defines the following auxillery functions: +* Calculate the size of a diff, only counting the amount + of lines added, and the amount of lines deleted. This can + be used to determine a best 'interdiff' (the shortest one + is the best one), when searching for two hunks that are + moved around. + -- 2.11.4.GIT