gitstats: Add a description about the bug module
authorSverre Rabbelier <sverre@rabbelier.nl>
Mon, 28 Jul 2008 12:49:28 +0000 (28 14:49 +0200)
committerSverre Rabbelier <sverre@rabbelier.nl>
Tue, 29 Jul 2008 13:55:53 +0000 (29 15:55 +0200)
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 [new file with mode: 0644]

diff --git a/doc/gitstats-bug.txt b/doc/gitstats-bug.txt
new file mode 100644 (file)
index 0000000..6ab7d19
--- /dev/null
@@ -0,0 +1,26 @@
+syntax: stats.py bug <options>
+
+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.
+