swr: bump minor version.
[ffmpeg.git] / doc / fate.txt
1 FATE Automated Testing Environment
2
3 FATE provides a regression testsuite that can be run locally or configured
4 to send reports to fate.ffmpeg.org.
5 In order to run, it needs a large amount of data (samples and references)
6 that is provided separately from the actual source distribution.
7
8 Use the following command to get the fate test samples
9
10 # make fate-rsync SAMPLES=fate-suite/
11
12 To inform the build system about the testsuite location, pass
13 `--samples=<path to the samples>` to configure or set the SAMPLES Make
14 variable or the FATE_SAMPLES environment variable to a suitable value.
15
16 For information on how to set up FATE to send results to the official FFmpeg
17 testing framework, please refer to the following wiki page:
18 http://wiki.multimedia.cx/index.php?title=FATE
19
20 FATE Makefile targets:
21
22 fate-list
23     Will list all fate/regression test targets.
24
25 fate
26     Run the FATE test suite (requires the fate-suite dataset).
27
28 Fate Makefile variables:
29
30 V
31     Verbosity level, can be set to 0, 1 or 2.
32     * 0: show just the test arguments
33     * 1: show just the command used in the test
34     * 2: show everything
35
36 SAMPLES
37     Specify or override the path to the FATE samples at make time, it has a
38     meaning only while running the regression tests.
39
40 THREADS
41     Specify how many threads to use while running regression tests, it is
42     quite useful to detect thread-related regressions.
43
44 Example:
45     make V=1 SAMPLES=/var/fate/samples THREADS=2 fate