[FFmpeg-devel] [PATCH] build system docs

[Michael Niedermayer]

On Wed, Oct 06, 2010 at 12:25:50AM +0200, Luca Barbato wrote:
> On 10/05/2010 10:42 PM, Michael Niedermayer wrote:
>> +Options to make: (some of these are standard options)
>> +make V=1<target>
>> +    Build target with verbosity 1, instead of 1, 2 can be used too
>
> Ok
>
>> +
>> +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 than.
>> +
>> +make -j<num>
>> +    rebuild with multiple jobs at the same time. Faster if you have the hw
>> +
>> +make -k
>> +    continue build in case of errors, this is usefull for the regression tests
>> +    sometimes but note it will still not run all reg tests.
>
> I'd move them to a section like
> "
> Useful standard make commands:
> "
>
> make -j -l N might be useful as well.
>
>> +Targets to make:
>> +fate-list
>> +    Will list all fate/regression test targets
>> +
>> +fate
>> +    Run the fate test suite, note you must have installed it
>
> I guess it's ok.
>
>> +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
>
> Might be useful having a make fate-sync target?

If i where configure maintainer a make fate would update the samples or
download them if they arent there.

New patch below (will commit soon if no objections)
 commit ec50e7502ee103800e80054ed067def230bcd56e
Author: Michael Niedermayer <michaelni at gmx.at>
Date:   Tue Oct 5 22:34:34 2010 +0200

    custom build system documentation

diff --git a/doc/build_system.txt b/doc/build_system.txt
new file mode 100644
index 0000000..d9e4f0a
--- /dev/null
+++ b/doc/build_system.txt
@@ -0,0 +1,34 @@
+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
+
+
+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.
+
+make -j<num>
+    rebuild with multiple jobs at the same time. Faster if you have the hw
+
+make -k
+    continue build in case of errors, this is usefull for the regression tests
+    sometimes but note it will still not run all reg tests.
+
+
+Targets to make:
+fate-list
+    Will list all fate/regression test targets
+
+fate
+    Run the fate test suite, note you must have installed it
+
+
+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




[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

It is dangerous to be right in matters on which the established authorities
are wrong. -- Voltaire
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20101006/c3d7f17a/attachment.pgp>