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