Checkin descriptive note

llvm-svn: 2765

1 files changed, 15 insertions, 0 deletions

diff --git a/llvm/tools/extract/README.txt b/llvm/tools/extract/README.txt
new file mode 100644
index 00000000000..6f0cda94cfb
--- /dev/null
+++ b/llvm/tools/extract/README.txt
@@ -0,0 +1,15 @@
+I checked in a new tool, primarily useful for debugging.  Given a module 
+and a function name, it extracts just the specified function from the 
+module, with a minimum of related cruft (global variables, function 
+prototypes, etc).
+
+This is useful because often something will die (for example SCCP 
+miscompiles one function of a large benchmark), and so you want to just 
+cut the testcase down to the one function that is being a problem.  In 
+this case, 'extract' eliminates all of the extraneous global variables, 
+type information, and functions that aren't neccesary, giving you 
+something simpler.
+
+This is just an FYI, because I've found it useful and thought you guys 
+might as well.
+