--- tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 tests/README.md
diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000000..4bcae0b403 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,48 @@ +FFmpeg tests +============ + +Tests are useful to make sure that code changes do not introduce regressions. + +## FATE tests + +FATE (FFmpeg Automated Test Environment) is the system used to test +regressions and should be used for new changes which affect the API or +components behavior. + +To run all tests, run the following command from the commandline: +``` +make fate +``` + +To get the complete list of tests: +``` +make fate-list +``` + +You can specify a subset of tests to run by specifying the +corresponding element form the list with the `fate-` prefix, e.g.: +``` +make fate-ffprobe_compact fate-ffprobe_xml +``` + +## FATE samples + +By default, FFmpeg uses only the standalone tests. To use the +collected FATE samples, you need download and configure the tests with +the FATE samples path. + +To upload or update the samples, run the command: +``` +make fate-rsync SAMPLES=/path/to/samples +``` + +Then you need to setup the path where the samples are located, either +when configuring with: +``` +./configure --samples=path/to/fate/samples +``` + +or when running the tests with: +``` +FATE_SAMPLES=path/to/fate/samples make fate +``` -- 2.25.1 _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
