doc/gitstats-bug.txt

   1 syntax: stats.py bug <options>
   2
   3 The purpose of the bug module is to gather statistics on
   4 bugfixes within the content, and to aggregate this
   5 information to provide with a report of the last N commits.
   6
   7 Currently the available metrics in the bug module are the
   8 following:
   9 * Determine whether a specific commit is a bugfix based on
  10   other metrics. When one of the metrics is 'positive',
  11   that is, it's return value indicates that the examined
  12   commit is a bugfix, the 'bugfix rating' is increased by
  13   a pre-configured amount. This amount can be specified per
  14   metric, and can be set to '0' to ignore it.
  15
  16 * Aggregate the above metric over the past N commits. Also,
  17   when running the above metric on more than one commit,
  18   cache the result of calls to the git binary so that the
  19   execution time is reduced. This means that the execution
  20   time is not directly proportional to the size of the
  21   repository. (Instead, there is a fixed 'start up' cost,
  22   after which there is a 'per commit' cost, which is
  23   relatively low.)
  24
  25 This module does not define any auxillery functions.
  26