tinderbox example

tools/tinderbox/README

@@ -15,22 +15,13 @@ Table of Contents
 * build-seamonkey.pl
    A perl script to drive the client side of tinderbox (unix variants).
    usage:
-      perl build-seamonkey.pl [--clobber | --depend] -t TreeName
+      build-seamonkey.pl [--clobber | --depend] [-t TreeName] [--testonly] [--once]
 
 * bloatdiff.pl
     Script used to process leak data in the logs.
 
 * build-seamonkey-util.pl
-    Meat of the unix/gmake tinderbox stuff.
-
-* build-seamonkey-win32.pl
-    Win32 nmake build tinderbox stuff.
-
-* gettime.pl
-    Wrapper around Time::HiRes
-
-* install-links
-    csh script to create symlinks from cvs dir to tinderbox root dir
+    Core unix tinderbox stuff.
 
 * post-mozilla-sample.pl
     Example of post-build test script
@@ -38,6 +29,46 @@ Table of Contents
 * tinder-defaults.pl
     Default script variables.
 
+* gettime.pl
+    Wrapper to get hires time, if available.
+
 * tinderbox
     Wrapper script to start unix builds.
 
+* install-links
+    Create links to a tinderbox install directory.
+
+
+Tinderbox example for SeaMonkey build
+=====================================
+
+Here is an example of how to set up a "SeaMonkey" tinderbox
+build of mozilla.
+
+  # Create tinderbox source files in mozilla,
+  # then SeaMonkey directory where mozilla tree will live.
+  cvs co mozilla/tools/tinderbox
+  mkdir SeaMonkey
+  cd SeaMonkey; ../mozilla/tools/tinderbox/install-links
+
+  #
+  # Create tinder-config.pl file in SeaMonkey directory.  
+  # Copy one from an existing build, or create a sample one and edit it:
+  #
+  ./build-seamonkey.pl --example-config > tinder-config.pl
+
+  #
+  # mozconfig.  If you have configure options, add them to a
+  # file named "mozconfig" in the SeaMonkey directory.
+  # Again, you can copy one from a build, or create one.
+  # For a default stock build, this file is not needed or
+  # can be blank.
+  #
+
+  # Start the tinderbox!  From the SeaMonkey directory:
+  ./tinderbox depend start
+
+  # You can watch the build run the first time with:
+  tail -f <objdir>/<logname>
+
+