doc/gitstats-index.txt

   1 syntax: stats.py index <options>
   2
   3 The purpose of the index module is to gather statistics
   4 about the index, or related to the index.
   5
   6 Currently the available metrics in the index module are the
   7 following:
   8 * List all the commits that touch the same files as the
   9   staged files. This can be useful to find out which commit
  10   introduced the bug fixed in this commit (by piping the
  11   output of this method to one that looks at which lines
  12   were touched for example).
  13
  14 It also defines the following auxillery functions:
  15 * Get all the staged changes (optionally ignoring newly
  16   added files). This is used internally to find all the
  17   commits that touched the same files as those that are
  18   currently staged.
  19