Mercurial > mplayer.hg
comparison DOCS/tech/patches.txt @ 12701:4e0acc8d3622
Explain that commenting string operations is important.
patch by Alexander Strasser <eclipse7@gmx.net>
| author | diego |
|---|---|
| date | Sun, 27 Jun 2004 12:38:38 +0000 |
| parents | 0d9dec871b83 |
| children | d63e770baf9f |
comparison
equal
deleted
inserted
replaced
| 12700:5ef61921bb78 | 12701:4e0acc8d3622 |
|---|---|
| 29 use 'diff -uwbBE' to help you remove them. Don't forget to check the | 29 use 'diff -uwbBE' to help you remove them. Don't forget to check the |
| 30 patch to make sure diff didn't ignore some important change and remove | 30 patch to make sure diff didn't ignore some important change and remove |
| 31 any remaining cosmetics! | 31 any remaining cosmetics! |
| 32 | 32 |
| 33 5. Comment parts that really need it (tricky side-effects etc). | 33 5. Comment parts that really need it (tricky side-effects etc). |
| 34 Commenting trivial code not required. Comments must be English! | 34 Always document string operations! Comment on what you are doing |
| 35 and why it is safe. This makes it easy to review and change your | |
| 36 code if needed. Commenting trivial code not required. | |
| 37 Comments must be English! | |
| 35 | 38 |
| 36 6. If you implement new features, add or change command line switches or | 39 6. If you implement new features, add or change command line switches or |
| 37 modify the behavior of existing features, please do not forget to also | 40 modify the behavior of existing features, please do not forget to also |
| 38 update the documentation. The documentation maintainers will assist you | 41 update the documentation. The documentation maintainers will assist you |
| 39 in doing this. Updating the English documentation is enough. If you | 42 in doing this. Updating the English documentation is enough. If you |