Updated kernel version 2.6.27.30 to 2.6.27.31.
[mirror/scst/.git] / nightly / README.txt
1
2 This directory (nightly/) contains a simple, automatic build-and-test
3 system for SCST, intended to be run by cron.
4
5 Note (importantly) it doesn't test the sources in the tree of which
6 this directory is a part (viz, nightly/..).  Instead it checks out
7 a complete new tree, builds and tests that independently of the
8 existing tree.
9
10 To use, choose a tag, probably a machine name, and run
11
12    bin/nightly <tag>
13
14 and supply the following two config files:
15
16 - conf/<tag>.conf:  this is sourced by the 'nightly' script, and can define
17   any or all of the following environment variables:
18
19   ABT_DETAILS: describes the machine in more detail, eg. the OS.  The default
20     is empty.
21   ABT_EVAL: if provided, it must be the name of a shell script that executes
22     the shell command $1 with arguments $2 .. ${$#}. Allows to compile and
23     run the SCST regression tests on another system than the system the
24     'nightly' script runs on. It is assumed that the remote system shares the
25     local filesystem tree through e.g. NFS. It is the responsibility of the
26     shell script to set the remote working directory such that it matches the
27     local current directory ($PWD).
28   ABT_JOBS: allows parallel builds -- it's passed as the argument to "make
29     -j" when building SCST and the tests.  The default is 1.
30   ABT_KERNELS: kernel version numbers to test SCST against.
31   ABT_TMPDIR: absolute path in which temporary files will be stored.
32
33 - conf/<tag>.sendmail:  this should be a script that sends an email to the
34   desired recipient (eg. the scst-developers list).  It takes three
35   command line arguments.  The first is the email subject line, the second
36   is the name of the file containing the email's body (showing the tests
37   that failed, and the difference between now and 24 hours ago), the third
38   is the name of the file containing all the diffs (which can be made into
39   an attachment, for example).
40
41 CREDITS
42
43 The automatic build-and-test infrastructure for the SCST project reuses some
44 ideas and shell script code from a similar infrastructure in the Valgrind project.