Merge commit '677c804aa3a78d61b21e6423165a252846c20f0e'
[ffmpeg.git] / doc / build_system.txt
1 FFmpeg currently uses a custom build system, this text attempts to document
2 some of its obscure features and options.
3
4 Makefile variables:
5
6 V
7     Disable the default terse mode, the full command issued by make and its
8     output will be shown on the screen.
9
10 DBG
11     Preprocess x86 external assembler files to a .dbg.asm file in the object
12     directory, which then gets compiled. Helps developping those assembler
13     files.
14
15 DESTDIR
16     Destination directory for the install targets, useful to prepare packages
17     or install FFmpeg in cross-environments.
18
19 GEN
20     Set to ‘1’ to generate the missing or mismatched references.
21
22 Makefile targets:
23
24 all
25     Default target, builds all the libraries and the executables.
26
27 fate
28     Run the fate test suite, note you must have installed it
29
30 fate-list
31     Will list all fate/regression test targets
32
33 install
34     Install headers, libraries and programs.
35
36 examples
37     Build all examples located in doc/examples.
38
39 libavformat/output-example
40     Build the libavformat basic example.
41
42 libavcodec/api-example
43     Build the libavcodec basic example.
44
45 libswscale/swscale-test
46     Build the swscale self-test (useful also as example).
47
48 config
49     Reconfigure the project with current configuration.
50
51
52 Useful standard make commands:
53 make -t <target>
54     Touch all files that otherwise would be build, this is useful to reduce
55     unneeded rebuilding when changing headers, but note you must force rebuilds
56     of files that actually need it by hand then.
57
58 make -j<num>
59     rebuild with multiple jobs at the same time. Faster on multi processor systems
60
61 make -k
62     continue build in case of errors, this is useful for the regression tests
63     sometimes but note it will still not run all reg tests.
64