Mercurial > mplayer.hg
annotate DOCS/tech/patches.txt @ 9302:e23939b2ac30
sync
author | gabucino |
---|---|
date | Thu, 06 Feb 2003 21:25:48 +0000 |
parents | ecff1745d189 |
children | 61ba1af7d87b |
rev | line source |
---|---|
2121 | 1 Sending patches: |
2 ~~~~~~~~~~~~~~~~ | |
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 | 12 |
6101 | 13 2. Make unified diffs ('diff -Naur' or 'cvs diff -u'). |
2121 | 14 |
6101 | 15 3. Test the functionality of your patch. We'll *refuse* it if it breaks |
2121 | 16 something, even if it extends other features! |
17 | |
6101 | 18 4. Read your patch. We'll *refuse* it if it changes indentation of the |
19 code or if it does tab/space conversion or other cosmetical changes! | |
2121 | 20 |
6101 | 21 5. Comment parts that really need it (tricky side-effects etc). |
22 Commenting trivial code not required. Comments must be English! | |
8556 | 23 |
24 6. If you implement new features, add or change command line switches or modify | |
25 the behavior of existing features, please do not forget to also update the | |
26 documentation. The documentation maintainers will assist you in doing this. | |
2121 | 27 |
8556 | 28 7. Send your patch to the mplayer-dev-eng mailing list as a base64-encoded |
7645
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
29 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
|
30 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
|
31 line: '[PATCH] very short description of the patch'. |
6101 | 32 In the mail, describe in a few sentences what you change and why. |
4202 | 33 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
|
34 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
|
35 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
|
36 for unapplied patches, so please use it. |
7645
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
37 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
|
38 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
|
39 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
|
40 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
|
41 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
|
42 nomail option if you do not wish to receive all the mails. |
2121 | 43 |
8556 | 44 8. Give us a few days to react. We try to review patches as fast as possible, |
8432 | 45 but unfortunately we are constantly overloaded with work, be it MPlayer |
46 related or from our day to day lives. If your patch seems to be ignored, | |
47 please resend it and mention that you got ignored. We are interested in your | |
48 work and will eventually either accept it or reject it with an explanation | |
49 what and why we disliked about your patch. | |
50 | |
8556 | 51 9. 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
|
52 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
|
53 MPlayer developer, you'll get CVS write access. |
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
54 |
2121 | 55 Thank you! |