2006-10-30 David Smith <dsmith@redhat.com>

	* stap.1.in: Added notes about new caching feature.

1 files changed, 16 insertions, 0 deletions

diff --git a/stap.1.in b/stap.1.in
index 7f2e91f3..526ef3c9 100644
--- a/stap.1.in
+++ b/stap.1.in
@@ -722,6 +722,16 @@ See the
 .IR stapex (5)
 manual page for a collection of samples.
 
+.SH CACHING
+The systemtap translator caches the pass 3 output (the generated C
+code) and the pass 4 output (the compiled kernel module) if pass 4
+completes successfully.  This cached output is reused if the same
+script is translated again assuming the same conditions exist (same kernel
+version, same systemtap version, etc.).  Cached files are stored in
+the
+.I $SYSTEMTAP_DIR/cache
+directory.
+
 .SH SAFETY AND SECURITY
 Systemtap is an administrative tool.  It exposes kernel internal data
 structures and potentially private user information.  It acquires root
@@ -785,6 +795,12 @@ Any pending trace messages may be lost.
 .SH FILES
 .\" consider autoconf-substituting these directories
 .TP
+~/.systemtap
+Systemtap data directory for cached systemtap files, unless overridden
+by the
+.I SYSTEMTAP_DIR
+environment variable.
+.TP
 /tmp/stapXXXXXX
 Temporary directory for systemtap files, including translated C code
 and kernel object.