fixing up module
[platform/upstream/gst-libav.git] / HACKING
1 What we are trying to achieve:
2
3 satisfy:
4   patching of CVS checkout using our patch files placed in our CVS
5
6   passing of
7     make
8     make distcheck
9     non-srcdir build (ie, mkdir build; cd build; ../configure; make)
10
11 How it works:
12
13 * configure checks whether or not it should update ffmpeg from CVS by looking
14   at the nano version number
15   - if it's 1, we're in cvs mode, and it should check it out
16   - if it's not 1, we're in prerel or rel mode, and the code should already
17     be on disk
18     FIXME: we could change this to really check out the source code if some
19     required files aren't there just in case someone checks out from CVS
20     but CVS is not at nano 1
21
22 * patching of the checked-out copy happens at
23
24 Axioms under which we work:
25 - the dist tarball needs to include either
26   - the pristine ffmpeg checkout + our patches + a patch mechanism on make
27   or
28   - the ffmpeg checkout with patches already applied
29
30 - configure/make is not allowed to touch files that already live in the source
31   tree; if they need to then they need to be copied first and cleaned
32   afterward
33
34 - it would be very nice if, on update of either the Tag file or the patch set,
35   make would know exactly what to do with it.
36