summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2010-02-17 08:34:44 -0700
committerJonathan Corbet <corbet@lwn.net>2010-02-17 08:34:44 -0700
commit68e82f808540ad733327c5653a98859de34843b9 (patch)
tree8825d499e0d45787fde861c4745d0bc0101a5ea4
parent49c689276d750dbc78fe7a5d0ff27e6d2278fcd4 (diff)
Update the documentation slightly
...in particular, say what the new tools do. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--README27
1 files changed, 27 insertions, 0 deletions
diff --git a/README b/README
index 62c8d31..3ae110d 100644
--- 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