]> xenbits.xensource.com Git - people/larsk/xenproject-org-gitdm.git/commitdiff
Update the documentation slightly
authorJonathan Corbet <corbet@lwn.net>
Wed, 17 Feb 2010 15:34:44 +0000 (08:34 -0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 17 Feb 2010 15:34:44 +0000 (08:34 -0700)
...in particular, say what the new tools do.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
README

diff --git a/README b/README
index 62c8d3143a1c69c4e61bca713e6ebcb553f373a0..3ae110d2ffc09c6e6277a6e7206b7cce4b8b2b98 100644 (file)
--- a/README
+++ b/README
@@ -91,6 +91,33 @@ GroupMap file employer
        email addresses only, all of which are associated with the given
        employer.
 
+OTHER TOOLS
+
+A few other tools have been added to this repository:
+
+  treeplot
+       Reads a set of commits, then generates a graphviz file charting the
+       flow of patches into the mainline.  Needs to be smarter, but, then,
+       so does everything else in this directory.
+
+  findoldfiles
+       Simple brute-force crawler which outputs the names of any files
+       which have not been touched since the original (kernel) commit.
+
+  committags
+       I needed to be able to quickly associate a given commit with the
+       major release which contains it.  First attempt used 
+       "git tags --contains="; after it ran for a solid week, I concluded
+       there must be a better way.  This tool just reads through the repo,
+       remembering tags, and creating a Python dictionary containing the
+       association.  The result is an ugly 10mb pickle file, but, even so,
+       it's still a better way.
+
+  linetags
+       Crawls through a directory hierarchy, counting how many lines of
+       code are associated with each major release.  Needs the pickle file
+       from committags to get the job done.
+
 
 NOTES AND CREDITS