From 1f4dc12186abc35e0244ccfdadd4b975adbe0be0 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 bug 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/gitstats-bug.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/gitstats-bug.txt diff --git a/doc/gitstats-bug.txt b/doc/gitstats-bug.txt new file mode 100644 index 0000000..6ab7d19 --- /dev/null +++ b/doc/gitstats-bug.txt @@ -0,0 +1,26 @@ +syntax: stats.py bug + +The purpose of the bug module is to gather statistics on +bugfixes within the content, and to aggregate this +information to provide with a report of the last N commits. + +Currently the available metrics in the bug module are the +following: +* Determine whether a specific commit is a bugfix based on + other metrics. When one of the metrics is 'positive', + that is, it's return value indicates that the examined + commit is a bugfix, the 'bugfix rating' is increased by + a pre-configured amount. This amount can be specified per + metric, and can be set to '0' to ignore it. + +* Aggregate the above metric over the past N commits. Also, + when running the above metric on more than one commit, + cache the result of calls to the git binary so that the + execution time is reduced. This means that the execution + time is not directly proportional to the size of the + repository. (Instead, there is a fixed 'start up' cost, + after which there is a 'per commit' cost, which is + relatively low.) + +This module does not define any auxillery functions. + -- 2.11.4.GIT