doc/gitstats-author.txt

   1 syntax: stats.py author <options>
   2
   3 The purpose of the author module is to gather statistics
   4 about authors, and to aggregate this information to provide
   5 information about all the authors of a repo.
   6
   7 Currently the available metrics in the author module are
   8 the following:
   9 * Determine how many changes an author made (making a
  10   distinction between lines added and lines deleted), and
  11   record this per author, for all files in the repository.
  12   It is possible to get this data for one specific author,
  13   (although data for all authors will still be gathered,)
  14   because the result is stored per author.
  15
  16 * Determine how many commits an author made that affected
  17   a specific file. This metric is less granular, but a lot
  18   faster. To retreive the more granular result, one could
  19   simply iterate over the result of the above metric for
  20   each author, and take only the data for the file one is
  21   interested in.
  22
  23 * Aggregate the information from the first metric, adding
  24   up the statistics from each author. This provides a more
  25   general 'file activity' metric and is a nice example of
  26   how an existing metric can be modified to do something
  27   seemingly unrelated.
  28
  29 This module does not define any auxillery functions.
  30