x86/doc/Makefile: DBG=1 to preprocess external asm
[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 Makefile targets:
20
21 all
22     Default target, builds all the libraries and the executables.
23
24 fate
25     Run the fate test suite, note you must have installed it
26
27 fate-list
28     Will list all fate/regression test targets
29
30 install
31     Install headers, libraries and programs.
32
33 examples
34     Build all examples located in doc/examples.
35
36 libavformat/output-example
37     Build the libavformat basic example.
38
39 libavcodec/api-example
40     Build the libavcodec basic example.
41
42 libswscale/swscale-test
43     Build the swscale self-test (useful also as example).
44
45 config
46     Reconfigure the project with current configuration.
47
48
49 Useful standard make commands:
50 make -t <target>
51     Touch all files that otherwise would be build, this is useful to reduce
52     unneeded rebuilding when changing headers, but note you must force rebuilds
53     of files that actually need it by hand then.
54
55 make -j<num>
56     rebuild with multiple jobs at the same time. Faster on multi processor systems
57
58 make -k
59     continue build in case of errors, this is useful for the regression tests
60     sometimes but note it will still not run all reg tests.
61