diff --git a/tools/footprint/leak-gauge.html b/tools/footprint/leak-gauge.html new file mode 100755 index 000000000000..b538e3ed0206 --- /dev/null +++ b/tools/footprint/leak-gauge.html @@ -0,0 +1,265 @@ + + + + +Leak Gauge + + + + + + +

Leak Gauge

+ +
$Id: leak-gauge.html,v 1.1 2006/01/13 23:37:23 dbaron%dbaron.org Exp $
+ +

This script is designed to help testers isolate and simplify testcases +for many classes of leaks (those that involve large graphs of core +data structures) in Mozilla-based browsers. It is designed to print +information about what has leaked by processing a log taken while +running the browser. Such a log can be taken over a long session of +normal browsing and then the log can be processed to find sites that +leak. Once a site is known to leak, the logging can then be repeated +to figure out under what conditions the leak occurs.

+ +
The way to create this log is to set the environment variables:
+  NSPR_LOG_MODULES=DOMLeak:5,DocumentLeak:5,nsDocShellLeak:5
+  NSPR_LOG_FILE=nspr.log     (or any other filename of your choice)
+in your shell and then run the program.
+* In a Windows command prompt, set environment variables with
+    set VAR=value
+* In an sh-based shell such as bash, set environment variables with
+    export VAR=value
+* In a csh-based shell such as tcsh, set environment variables with
+    setenv VAR value
+ +

Then enter the filename of the log and you'll +see the output, which will tell you which of certain core objects leaked and +the URLs associated with those objects.

+ + +