annotate DOCS/tech/patches.txt @ 8510:43a716922d41

1l (%d->%f), cosmetics
author arpi
date Sat, 21 Dec 2002 20:39:40 +0000
parents 7b6b7fb76965
children ecff1745d189
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 ~~~~~~~~~~~~~~~~
95b8a1e7962d sending patches
arpi
parents:
diff changeset
3
7645
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
4 Note: We know our rules place a burden on you, but rest assured that
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
5 maintaining a big and complex software project is even harder, so please
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
6 accept our rules. We cannot afford to spend our time fixing buggy, broken or
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
7 outdated patches.
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
8
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
9 1. Always make patches for the CVS version. The README describes how to check
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
10 out CVS and daily CVS snapshots are available from our download page.
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
11 We do not accept patches for releases or outdated CVS versions.
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
12
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
13 2. Make unified diffs ('diff -Naur' or 'cvs diff -u').
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
14
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
15 3. Test the functionality of your patch. We'll *refuse* it if it breaks
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
16 something, even if it extends other features!
95b8a1e7962d sending patches
arpi
parents:
diff changeset
17
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
18 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
19 code or if it does tab/space conversion or other cosmetical changes!
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
20
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
21 5. Comment parts that really need it (tricky side-effects etc).
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
22 Commenting trivial code not required. Comments must be English!
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
23
7645
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
24 6. Send your patch to the mplayer-dev-eng mailing list as a base64-encoded
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
25 attachment (use gzip or bzip2 *only* if it's bigger than 80k or if you know
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
26 that your mailer messes up (reformats) text attachments) with the subject
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
27 line: '[PATCH] very short description of the patch'.
6101
ff80fbfa06f5 corrections by Diego Biurrun <diego@biurrun.de>
jaf
parents: 4202
diff changeset
28 In the mail, describe in a few sentences what you change and why.
4202
408302343afe mail formatting added
arpi
parents: 2121
diff changeset
29 If you made independent changes, try to send them as separate patches.
7153
56cef6e35f51 Explain why putting [PATCH] in the subject is important.
diego
parents: 6101
diff changeset
30 The subject line is very important if you do not want your patch to get
56cef6e35f51 Explain why putting [PATCH] in the subject is important.
diego
parents: 6101
diff changeset
31 lost in the noise. We need the uppercase [PATCH] to be able to search
56cef6e35f51 Explain why putting [PATCH] in the subject is important.
diego
parents: 6101
diff changeset
32 for unapplied patches, so please use it.
7645
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
33 You have to subscribe to mplayer-dev-eng since we blocked postings from
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
34 non-subscribers after spam problems and because patches get reviewed by the
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
35 developers on the list. We want you to be available for discussing your
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
36 code, you might be asked to make modifications before we accept it. Don't
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
37 worry, mplayer-dev-eng is not high traffic and you can subscribe with the
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
38 nomail option if you do not wish to receive all the mails.
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
39
8432
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
40 7. Give us a few days to react. We try to review patches as fast as possible,
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
41 but unfortunately we are constantly overloaded with work, be it MPlayer
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
42 related or from our day to day lives. If your patch seems to be ignored,
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
43 please resend it and mention that you got ignored. We are interested in your
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
44 work and will eventually either accept it or reject it with an explanation
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
45 what and why we disliked about your patch.
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
46
7b6b7fb76965 small updates
diego
parents: 7645
diff changeset
47 8. Do not immediately ask for CVS write access. If you contributed one or more
7645
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
48 nice, acceptable patches and they need maintaining or you want to be an
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
49 MPlayer developer, you'll get CVS write access.
534b9b6f6557 Some further explanations, dev-eng is now subscribers only.
diego
parents: 7153
diff changeset
50
2121
95b8a1e7962d sending patches
arpi
parents:
diff changeset
51 Thank you!