diff options
author | Luca Barbato <lu_zero@gentoo.org> | 2011-03-22 02:20:56 +0300 |
---|---|---|
committer | Luca Barbato <lu_zero@gentoo.org> | 2011-03-25 11:48:25 +0300 |
commit | c535d0896e6f08d9526da57b0b4fece19c22b59f (patch) | |
tree | 6aaff5546beccb5102f54285b9d10f0c1bc8ef2f /doc/fate.txt | |
parent | 00f0b4b92efbe78fd39fbb18d387d060d604ac75 (diff) |
doc: update build system documentation
Split normal build system documentation and the fate one.
Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.
Diffstat (limited to 'doc/fate.txt')
-rw-r--r-- | doc/fate.txt | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/fate.txt b/doc/fate.txt new file mode 100644 index 0000000000..f5f3759309 --- /dev/null +++ b/doc/fate.txt @@ -0,0 +1,45 @@ +FATE Automated Testing Environment + +FATE provides a regression testsuite that can be run locally or configured +to send reports to fate.libav.org. +In order to run, it needs a large amount of data (samples and references) +that is provided separately from the actual source distribution. + +Use the following command to get the fate test samples + +# rsync -aL rsync://samples.libav.org:/samples/fate-suite/ fate-suite + +To inform the build system about the testsuite location, pass +`--samples=<path to the samples>` to configure or set the SAMPLES Make +variable or the FATE_SAMPLES environment variable to a suitable value. + +For information on how to set up FATE to send results to the official Libav +testing framework, please refer to the following wiki page: +http://wiki.multimedia.cx/index.php?title=FATE + +FATE Makefile targets: + +fate-list + Will list all fate/regression test targets. + +fate + Run the FATE test suite (requires the fate-suite dataset). + +Fate Makefile variables: + +V + Verbosity level, can be set to 0, 1 or 2. + * 0: show just the test arguments + * 1: show just the command used in the test + * 2: show everything + +SAMPLES + Specify or override the path to the FATE samples at make time, it has a + meaning only while running the regression tests. + +THREADS + Specify how many threads to use while running regression tests, it is + quite useful to detect thread-related regressions. + +Example: + make V=1 SAMPLES=/var/fate/samples THREADS=2 fate |