From: Sverre Rabbelier <sverre@rabbelier.nl>
Date: Mon, 28 Jul 2008 12:49:28 +0000 (+0200)
Subject: gitstats: Add a description about the index module
X-Git-Url: https://repo.or.cz/w/git-stats.git/commitdiff_plain/fa460fa31ebb0d5cae1d9a16b57f73f1c3482298

gitstats: Add a description about the index 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.
---

diff --git a/doc/index.txt b/doc/index.txt
new file mode 100644
index 0000000..66c79eb
--- /dev/null
+++ b/doc/index.txt
@@ -0,0 +1,19 @@
+syntax: stats.py index <options>
+
+The purpose of the index module is to gather statistics
+about the index, or related to the index.
+
+Currently the available metrics in the index module are the
+following:
+* List all the commits that touch the same files as the
+  staged files. This can be useful to find out which commit
+  introduced the bug fixed in this commit (by piping the
+  output of this method to one that looks at which lines
+  were touched for example).
+
+It also defines the following auxillery functions:
+* Get all the staged changes (optionally ignoring newly
+  added files). This is used internally to find all the
+  commits that touched the same files as those that are
+  currently staged.
+