doc/filters.texi: ebur128 grammar fix
[ffmpeg.git] / doc / build_system.txt
index 8a20069..a9bd4eb 100644 (file)
@@ -1,37 +1,64 @@
 FFmpeg currently uses a custom build system, this text attempts to document
 some of its obscure features and options.
 
-Options to make:
-make V=1 <target>
-    Build target with verbosity 1, instead of 1, 2 can be used too
-make SAMPLES=<path to the fate samples> <target>
-    specify the path to the fate samples at make time
+Makefile variables:
 
+V
+    Disable the default terse mode, the full command issued by make and its
+    output will be shown on the screen.
 
-Useful standard make commands:
-make -t <target>
-    Touch all files that otherwise would be build, this is useful to reduce
-    unneeded rebuilding when changing headers, but note you must force rebuilds
-    of files that actually need it by hand then.
+DBG
+    Preprocess x86 external assembler files to a .dbg.asm file in the object
+    directory, which then gets compiled. Helps in developing those assembler
+    files.
 
-make -j<num>
-    rebuild with multiple jobs at the same time. Faster on multi processor systems
+DESTDIR
+    Destination directory for the install targets, useful to prepare packages
+    or install FFmpeg in cross-environments.
 
-make -k
-    continue build in case of errors, this is useful for the regression tests
-    sometimes but note it will still not run all reg tests.
+GEN
+    Set to ‘1’ to generate the missing or mismatched references.
 
+Makefile targets:
 
-Targets to make:
-fate-list
-    Will list all fate/regression test targets
+all
+    Default target, builds all the libraries and the executables.
 
 fate
-    Run the fate test suite, note you must have installed it
+    Run the fate test suite, note that you must have installed it.
+
+fate-list
+    List all fate/regression test targets.
+
+install
+    Install headers, libraries and programs.
+
+examples
+    Build all examples located in doc/examples.
+
+libavformat/output-example
+    Build the libavformat basic example.
 
+libavcodec/api-example
+    Build the libavcodec basic example.
+
+libswscale/swscale-test
+    Build the swscale self-test (useful also as an example).
+
+config
+    Reconfigure the project with the current configuration.
+
+
+Useful standard make commands:
+make -t <target>
+    Touch all files that otherwise would be built, this is useful to reduce
+    unneeded rebuilding when changing headers, but note that you must force rebuilds
+    of files that actually need it by hand then.
+
+make -j<num>
+    Rebuild with multiple jobs at the same time. Faster on multi processor systems.
+
+make -k
+    Continue build in case of errors, this is useful for the regression tests
+    sometimes but note that it will still not run all reg tests.
 
-Setting up local fate:
-use the following command to get the fate test samples
-rsync -aL rsync://rsync.mplayerhq.hu:/samples/fate-suite/ fate/fate-suite
-pass --samples=<path to the samples> to configure or pass the path with the
-SAMPLES variable to make