SCons / timings / README.txt

Diff from to

timings/README.txt

 Each configuration exists in a subdirectory.  The controlling script
 is named TimeSCons-run.py for the configuration.  The TimeSCons-run.py
 scripts use TestSCons.TimeSCons, a subclass of TestSCons.TestSCons (both
-defined in ../QMTest/TestScons.py), to manage execution of the timing
+defined in ../QMTest/TestSCons.py), to manage execution of the timing
 runs.
 
 Unlike the TestSCons.TestSCons base class, the TestSCons.TimeSCons
 temporary directory used to run the timing.
 
 
+RUNNING YOUR TIMING CONFIGURATION
+=================================
+
+Because the TimeSCons.py module is a subclass of the whole TestSCons
+hierarchy, you use a normal runtest.py invocation to run the timings
+configuration:
+
+    $ python runtest.py timings/Configuration/TimeSCons-run.py
+                                 
+This runs the entire timing configuration, which actually runs SCons
+itself three times:
+
+    1)  First, with the --help option, to exit immediately after
+        reading the SConscript file(s).  This allows us to get a
+        rough independent measurement of how much startup cost is
+        involved in this configuration, so that the amount can be
+        discounted from the
+
+    2)  A full build.
+
+    3)  An rebuild of the full build, which is presumably up-to-date.
+
+When you execute runtest.py from the command line, the  output of
+each SCons run is printed on standard output.  (Note this means
+that the output can get pretty large if the timing configuration
+involves thousands of files.)
+
+The collected memory and time statistics for each run are printed
+on standard output, each with the prefix "TRACE:".  These are the
+lines that the buildbot grabs to collect the timing statistics for
+the graphs available on the web site.
+
+
 CALIBRATING YOUR TIMING CONFIGURATION
 =====================================
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.