Rename to README.testsuite, and bring it up to date.
[rsync/rsync.git] / testsuite / README.testsuite
1 automatic testsuite for rsync                   -*- text -*-
2
3 We're trying to develop some more substantial tests to prevent rsync
4 regressions.  Ideally, all code changes or bug reports would come with
5 an appropriate test suite.
6
7 You can run these tests by typing "make check" in the build directory.
8 The tests will run using the rsync binary in the build directory, so
9 you do not need to do "make install" first.  Indeed, you probably
10 should not install rsync before running the tests.
11
12 If you instead type "make installcheck" then the suite will test the
13 rsync binary found on the path.  You can use this to test a
14 distribution build, or perhaps by setting $PATH to run a new test
15 suite against an old version of rsync.
16
17 If the tests pass, you should see a report to that effect.  Some tests
18 require being root or some other precondition, and so will normally be
19 checked -- look at the test scripts for more information.
20
21 If the tests fail, you will see rather more output.  The scratch
22 directory will remain in the build directory.  It would be useful if
23 you could include the log messages when reporting a failure.
24
25 These tests also run automatically on the build farm, and you can see
26 the results on http://build.samba.org/.
27
28