Comment-only changes.

trunk/nightly/bin/nightly
trunk/nightly/README.txt
    Greatly improved the description of how to use this script;  a user now
    has a fighting chance of using the script without actually reading it.

trunk/nightly/conf/nemesis.sendmail
trunk/nightly/conf/georgia-tech-cellbuzz.sendmail
    Clarified the usage comments.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@8913

diff --git a/nightly/README.txt b/nightly/README.txt
index a00dc11e585493fc903e64845fd88f93101c720f..76ab6ca30812a6e4f0279af46002ab1cb63bf478 100644 (file)
--- a/nightly/README.txt
+++ b/nightly/README.txt
@@ -9,7 +9,24 @@ existing tree.
 
 To use, choose a tag, probably a machine name, and run
 
-   bin/nightly  /path/to/valgrind/nightly  tag
+   bin/nightly  /path/to/valgrind/nightly  <tag>
 
-and supply conf/tag.conf and conf/tag.sendmail.
+and supply the following two config files:
 
+- conf/<tag>.conf:  this is sourced by the 'nightly' script, and can define
+  any or all of the following environment variables:
+
+  ABT_DETAILS: describes the machine in more detail, eg. the OS.  The default
+    is empty.
+  ABT_CONFIGURE_OPTIONS: gives extra configure options.  The default is empty.
+  ABT_RUN_REGTEST: if provided, it must be the name of an argumentless shell
+    function (also specified in the tag.conf file) it's an argumentless bash
+    function that will be used to run the tests.  If not specified, the usual
+    "perl tests/vg_regtest --all" will be used.
+  ABT_JOBS: allows parallel builds -- it's passed as the argument to "make
+    -j" when building Valgrind and the tests.  The default is 1.
+
+- conf/<tag>.sendmail:  this should be a script that sends an email to the
+  desired recipient (eg. the valgrind-developers list).  It must take two
+  command line arguments.  The first is the email subject line, the second
+  is the email's body.

diff --git a/nightly/bin/nightly b/nightly/bin/nightly
index 0e4308853178de03406cff2512517acd46c86613..10079943623a319096ad4fe0d35be39b969664a0 100755 (executable)
--- a/nightly/bin/nightly
+++ b/nightly/bin/nightly
@@ -2,10 +2,7 @@
 
 #----------------------------------------------------------------------------
 # Automated build and test for Valgrind.  Compares Valgrind from 24 hours
-# ago with the current one.
-#
-#   Use: two args, first is path to top of ValgrindABT tree
-#        second is name of machine
+# ago with the current one.  See the README.txt on how to run it.
 #----------------------------------------------------------------------------
 
 #----------------------------------------------------------------------------

diff --git a/nightly/conf/georgia-tech-cellbuzz.sendmail b/nightly/conf/georgia-tech-cellbuzz.sendmail
index a65f1e1563a6d86380e6192e9c5fcb06bc74f3e1..6463484c5376270fa9c522fc6ababc4cc0db5e18 100755 (executable)
--- a/nightly/conf/georgia-tech-cellbuzz.sendmail
+++ b/nightly/conf/georgia-tech-cellbuzz.sendmail
@@ -1,4 +1,4 @@
 
-#use: subject file-to-mail
+# use: georgia-tech-cellbuzz.sendmail subject file-to-mail
 
 /bin/mailx -s "$1" valgrind-developers@lists.sourceforge.net -- -R bart.vanassche@gmail.com -r bart.vanassche@gmail.com < $2

diff --git a/nightly/conf/nemesis.sendmail b/nightly/conf/nemesis.sendmail
index ca6af71e3cacc910fd01e59283d102614ad65255..717bbe04b91a9b047467589118c84b887f37581c 100755 (executable)
--- a/nightly/conf/nemesis.sendmail
+++ b/nightly/conf/nemesis.sendmail
@@ -1,5 +1,5 @@
 
-#use: subject file-to-mail
+# use: nemesis.sendmail subject file-to-mail
 
 /usr/bin/mail -s "$1" -R jseward@acm.org -r jseward@acm.org valgrind-developers@lists.sourceforge.net < $2
- 
\ No newline at end of file
+