annotate DOCS/tech/patches.txt @ 7051:d03fad6123a3

asserts to check buffer size and non overlapingness
author michael
date Wed, 21 Aug 2002 19:08:24 +0000
parents ff80fbfa06f5
children 56cef6e35f51
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
1 Sending patches:
95b8a1e7962d sending patches
arpi
parents:
diff changeset
2 ~~~~~~~~~~~~~~~~
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
3 Note: We know these rules are hard, but it's hard to maintain such a
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
4 big and complex project, so you should accept our rules. We have no
95b8a1e7962d sending patches
arpi
parents:
diff changeset
5 time for fixing buggy, broken or old patches!
95b8a1e7962d sending patches
arpi
parents:
diff changeset
6
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
7 1. Always make patches for the CVS version.
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
8 We do not accept patches for old versions or releases.
95b8a1e7962d sending patches
arpi
parents:
diff changeset
9
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
10 2. Make unified diffs ('diff -Naur' or 'cvs diff -u').
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
11
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
12 3. Test the functionality of your patch. We'll *refuse* it if it breaks
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
13 something, even if it extends other features!
95b8a1e7962d sending patches
arpi
parents:
diff changeset
14
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
15 4. Read your patch. We'll *refuse* it if it changes indentation of the
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
16 code or if it does tab/space conversion or other cosmetical changes!
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
17
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
18 5. Comment parts that really need it (tricky side-effects etc).
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
19 Commenting trivial code not required. Comments must be English!
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
20
95b8a1e7962d sending patches
arpi
parents:
diff changeset
21 6. Do not ask for CVS write access at first time. If you contributed
95b8a1e7962d sending patches
arpi
parents:
diff changeset
22 1 or more nice, acceptable patches and they need maintaining or
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
23 you want to be an mplayer developer, you'll get CVS write access.
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
24
95b8a1e7962d sending patches
arpi
parents:
diff changeset
25 7. Subscribe to the mplayer-dev-eng list (don't worry, it's low traffic)
95b8a1e7962d sending patches
arpi
parents:
diff changeset
26 and send your patch there as base64-encoded attachment (use gzip or
4202
408302343afe mail formatting added
arpi
parents: 2121
diff changeset
27 bzip2 *only* if it's really big or if you know that your mailer messes
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
28 up (reformats) text attachments).
4202
408302343afe mail formatting added
arpi
parents: 2121
diff changeset
29 Subject line should be: '[PATCH] very short description of the patch'.
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
30 In the mail, describe in a few sentences what you change and why.
4202
408302343afe mail formatting added
arpi
parents: 2121
diff changeset
31 If you made independent changes, try to send them as separate patches.
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
32
95b8a1e7962d sending patches
arpi
parents:
diff changeset
33 Thank you!
95b8a1e7962d sending patches
arpi
parents:
diff changeset
34
95b8a1e7962d sending patches
arpi
parents:
diff changeset
35 A'rpi