Mercurial > mplayer.hg
annotate DOCS/tech/patches.txt @ 11467:d3fc1feb652a
Small format fixes.
author | mosu |
---|---|
date | Sat, 15 Nov 2003 22:46:47 +0000 |
parents | 74e69aef2406 |
children | a79d9b3a83fd |
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 |
11191 | 9 0. Do not send complete files. These need to be diffed by hand to see the |
10 changes, which makes reviews harder and less likely to occur. Besides as | |
11196 | 11 soon as one of the files changes, your version becomes harder to apply, |
12 thus reducing its chances of being accepted. | |
11191 | 13 |
7645
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
14 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
|
15 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
|
16 We do not accept patches for releases or outdated CVS versions. |
2121 | 17 |
9816 | 18 2. Make unified diffs ('diff -Naur' or 'cvs diff -u'). Unified diffs can easily |
19 be applied with 'patch'. This is much harder with other diff types. | |
2121 | 20 |
6101 | 21 3. Test the functionality of your patch. We'll *refuse* it if it breaks |
2121 | 22 something, even if it extends other features! |
23 | |
6101 | 24 4. Read your patch. We'll *refuse* it if it changes indentation of the |
25 code or if it does tab/space conversion or other cosmetical changes! | |
2121 | 26 |
6101 | 27 5. Comment parts that really need it (tricky side-effects etc). |
28 Commenting trivial code not required. Comments must be English! | |
8556 | 29 |
30 6. If you implement new features, add or change command line switches or modify | |
31 the behavior of existing features, please do not forget to also update the | |
32 documentation. The documentation maintainers will assist you in doing this. | |
10943 | 33 Updating the English documentation is enough. If you speak several languages |
34 you are of course welcome to update others as well. | |
2121 | 35 |
8556 | 36 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
|
37 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
|
38 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
|
39 line: '[PATCH] very short description of the patch'. |
6101 | 40 In the mail, describe in a few sentences what you change and why. |
4202 | 41 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
|
42 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
|
43 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
|
44 for unapplied patches, so please use it. |
7645
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
45 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
|
46 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
|
47 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
|
48 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
|
49 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
|
50 nomail option if you do not wish to receive all the mails. |
2121 | 51 |
8556 | 52 8. Give us a few days to react. We try to review patches as fast as possible, |
8432 | 53 but unfortunately we are constantly overloaded with work, be it MPlayer |
54 related or from our day to day lives. If your patch seems to be ignored, | |
55 please resend it and mention that you got ignored. We are interested in your | |
56 work and will eventually either accept it or reject it with an explanation | |
57 what and why we disliked about your patch. | |
58 | |
8556 | 59 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
|
60 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
|
61 MPlayer developer, you'll get CVS write access. |
11283 | 62 |
63 10. For consistency reasons all option names must use '-' instead of '_'. | |
11459
74e69aef2406
Contributors should also patch AUTHORS if they wish to appear there.
diego
parents:
11283
diff
changeset
|
64 |
74e69aef2406
Contributors should also patch AUTHORS if they wish to appear there.
diego
parents:
11283
diff
changeset
|
65 11. If you made a nontrivial contribution and wish to be mentioned in the |
74e69aef2406
Contributors should also patch AUTHORS if they wish to appear there.
diego
parents:
11283
diff
changeset
|
66 AUTHORS file, include that in your patch. |
7645
534b9b6f6557
Some further explanations, dev-eng is now subscribers only.
diego
parents:
7153
diff
changeset
|
67 |
2121 | 68 Thank you! |