Mercurial > mplayer.hg
annotate DOCS/tech/svn-howto.txt @ 23047:702085652768
Suggest svn diff command that does not show most cosmetics
author | reimar |
---|---|
date | Sun, 22 Apr 2007 15:11:47 +0000 |
parents | 6fb4b3944764 |
children | 05608cdd13f4 |
rev | line source |
---|---|
2200 | 1 |
18660 | 2 About Subversion write access: |
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
2200 | 4 |
18705 | 5 Before everything else, you should know how to use Subversion properly. |
18840 | 6 Luckily Subversion comes with excellent documentation. |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
7 |
18705 | 8 svn help |
18840 | 9 |
10 shows you the available subcommands, | |
11 | |
12 svn help <command> | |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
13 |
18840 | 14 shows information about the subcommand <command>. |
15 | |
16 The most comprehensive manual is the book "Version Control with Subversion" | |
17 by Ben Collins-Sussman, Brian W. Fitzpatrick and C. Michael Pilato. It can | |
18 be viewed online at | |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
19 |
18705 | 20 http://svnbook.org/ |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
21 |
18705 | 22 For more information about the Subversion project, visit |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
23 |
18705 | 24 http://subversion.tigris.org/ |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
25 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
26 Consult these resources whenever you have problems, they are quite exhaustive. |
18840 | 27 |
28 What follows now is a basic introduction to Subversion and some MPlayer-specific | |
29 guidelines. Read it at least once, if you are granted commit privileges to the | |
30 MPlayer project you are expected to be familiar with these rules. | |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
31 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
32 |
18841 | 33 |
18840 | 34 I. BASICS: |
35 ========== | |
36 | |
19248
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
37 0. Get Subversion: |
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
38 |
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
39 The MPlayer project server runs Subversion 1.2.3. For optimal compatibility |
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
40 you should use version 1.2.3 or later. |
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
41 |
dd30cb46819d
Add a paragraph about which Subversion version to use.
diego
parents:
18845
diff
changeset
|
42 |
18840 | 43 1. Checking out the source tree: |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
44 |
18840 | 45 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ <target> |
2200 | 46 |
18840 | 47 This will put the MPlayer sources into the directory <target>. |
2200 | 48 |
18841 | 49 |
18840 | 50 2. Updating the source tree to the latest revision: |
18706 | 51 |
52 svn update | |
12024 | 53 |
18840 | 54 pulls in the latest changes from the repository to your working directory. |
55 | |
18841 | 56 |
18840 | 57 3. Adding/removing files/directories: |
58 | |
59 svn add <filename/dirname> | |
60 svn delete <filename/dirname> | |
61 | |
62 Subversion needs to get notified of all changes you make to your working | |
63 directory. | |
64 | |
18841 | 65 |
18840 | 66 4. Showing modifications: |
67 | |
68 svn diff <filename(s)> | |
69 | |
70 will show all local modifications in your working directory as unified diff. | |
71 | |
18841 | 72 |
18840 | 73 5. Inspecting the changelog: |
74 | |
75 svn log <filename(s)> | |
76 | |
77 You may also find viewvc, a web frontend for Subversion, helpful. It's often | |
78 more comfortable than using 'svn log' and 'svn diff'. Find it here: | |
79 http://svn.mplayerhq.hu/mplayer/trunk/ | |
80 | |
18841 | 81 |
18840 | 82 6. Checking source tree status: |
83 | |
84 svn status | |
85 | |
86 detects all the changes you made and lists what actions will be taken in case | |
87 of a commit (additions, modifications, deletions, etc.). | |
88 | |
18841 | 89 |
18840 | 90 7. Committing: |
2200 | 91 |
18767 | 92 svn update |
18840 | 93 |
94 Run 'svn update' before committing to make sure there were no changes to the | |
95 files you worked on in the meantime. Afterwards look at the output of | |
96 | |
97 svn diff <filename(s)> | |
12024 | 98 |
18840 | 99 to doublecheck your changes before committing to avoid trouble later on. All |
100 experienced developers do this on each and every commit, no matter how small. | |
101 Every one of them has been saved from looking like a fool by this many times. | |
102 It's very easy for stray debug output or cosmetic modifications to slip in, | |
103 please avoid problems through this extra level of scrutiny. | |
104 | |
23047
702085652768
Suggest svn diff command that does not show most cosmetics
reimar
parents:
22511
diff
changeset
|
105 For cosmetics-only commits you should get (almost) empty output from |
702085652768
Suggest svn diff command that does not show most cosmetics
reimar
parents:
22511
diff
changeset
|
106 |
702085652768
Suggest svn diff command that does not show most cosmetics
reimar
parents:
22511
diff
changeset
|
107 svn diff --diff-cmd diff -x '-duwbB' <filename(s)> |
702085652768
Suggest svn diff command that does not show most cosmetics
reimar
parents:
22511
diff
changeset
|
108 |
19573
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
109 Also check the output of |
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
110 |
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
111 svn status |
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
112 |
19662 | 113 to make sure you did not forget to 'svn add' some files (they will be marked |
19573
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
114 with '?'). |
35d9fef1879e
svn diff does not show files you forgot to add, so recommend of svn status, too
reimar
parents:
19382
diff
changeset
|
115 |
18840 | 116 Once you have made sure everything is fine |
117 | |
118 svn commit <filename(s)> | |
119 | |
120 propagates your stuff to the repository. If you have made several independent | |
121 changes, commit them separately, not at the same time. | |
122 | |
123 When prompted for a password, type the password you got assigned by the | |
124 project admins. By default, Subversion caches all authentication tokens. | |
22510 | 125 This behavior can be disabled by setting both 'store-passwords' and |
18706 | 126 'store-auth-creds' to "no" in ~/.subversion/config. You might need to remove |
127 previous cache files, which are located in ~/.subversion/auth, by hand. | |
12024 | 128 |
18840 | 129 You will be prompted for a log message in an editor, which is either specified |
130 by --editor-cmd on the command line, set in your personal configuration file | |
131 (~/.subversion/config) or set by one of the following environment variables: | |
132 SVN_EDITOR, VISUAL or EDITOR. | |
12024 | 133 |
18840 | 134 Log messages should be concise but descriptive. Explain why you made a change, |
135 what you did will be obvious from the changes themselves most of the time. | |
136 Saying just "bug fix" or "10l" is bad. Remember that people of varying skill | |
137 levels look at and educate themselves while reading through your code. Don't | |
138 include filenames in log messages, Subversion provides that information. | |
18706 | 139 |
18841 | 140 |
19357
59af53f4f436
update the moving & copying rules as disscussed on mplayer-dev + some (but not all as iam lazy) fixes by the wanderer
michael
parents:
19248
diff
changeset
|
141 8. Renaming/moving/copying files or contents of files: |
13288 | 142 |
19376 | 143 svn move/copy <source> <destination> |
18840 | 144 svn commit <source> <destination> |
2200 | 145 |
19376 | 146 Do not move, rename or copy files of which you are not the maintainer without |
147 discussing it on the mplayer-dev-eng mailing list first! | |
19357
59af53f4f436
update the moving & copying rules as disscussed on mplayer-dev + some (but not all as iam lazy) fixes by the wanderer
michael
parents:
19248
diff
changeset
|
148 |
19376 | 149 Never copy or move a file by using 'svn delete' and 'svn add'. Always use |
150 'svn move' or 'svn copy' instead in order to preserve history and minimize | |
151 the size of diffs. | |
19357
59af53f4f436
update the moving & copying rules as disscussed on mplayer-dev + some (but not all as iam lazy) fixes by the wanderer
michael
parents:
19248
diff
changeset
|
152 |
19376 | 153 To split a file, use 'svn copy' and remove the unneeded lines from each file. |
2200 | 154 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
155 Don't do a lot of cut'n'paste from one file to another without a very good |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
156 reason and discuss it on the mplayer-dev-eng mailing list first. It will make |
18840 | 157 those changes hard to trace. |
5415 | 158 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
159 Such actions are useless and treated as cosmetics in 99% of cases, |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
160 so try to avoid them. |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
161 |
18841 | 162 |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
163 9. Reverting broken commits |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
164 |
19382 | 165 There are 2 ways to reverse a change, they differ significantly in what they |
22510 | 166 do to the repository. |
19382 | 167 The recommit old method: |
168 svn merge | |
169 svn ci <file> | |
22510 | 170 This simply changes the file(s) back to their old version locally and then |
171 the change is committed as if it were a new change. | |
19382 | 172 The svn copy method |
173 svn rm <file> | |
174 svn ci <file> | |
175 svn cp -r<good revision> svn://svn.mplayerhq.hu/mplayer/trunk/[<path>/]<file> <file> | |
176 svn ci <file> | |
177 This simply removes the file and then copies the last good version with | |
22510 | 178 its history over it. This method can only be used to revert the n last |
179 commits but not to revert a bad commit in the middle of its history. | |
19382 | 180 Neither method will change the history, checking out an old version will |
181 always return exactly that revision with all its bugs and features. The | |
182 difference is that with the svn copy method the broken commit will not be | |
22238 | 183 part of the directly visible history of the revisions after the reversal |
184 So if the change was completely broken like reindenting a file against the | |
185 maintainers decision, or a change which mixed functional and cosmetic | |
22345 | 186 changes then it is better if it is not part of the visible history as it |
22510 | 187 would make it hard to read, review and would also break svn annotate. |
19382 | 188 For the example of a change which mixed functional and cosmetic parts they |
22238 | 189 should of course be committed again after the reversal but separately, so one |
22510 | 190 change with the functional stuff and one with the cosmetics. |
19382 | 191 OTOH if the change which you want to reverse was simply buggy but not |
192 totally broken then it should be reversed with svn merge as otherwise | |
22510 | 193 the fact that the change was bad would be hidden. |
19382 | 194 One method to decide which reversal method is best is to ask yourself |
22345 | 195 if there is any value in seeing the whole bad change and its removal |
22502 | 196 in SVN vs. just seeing a comment that says what has been reversed while |
22238 | 197 the actual change does not clutter the immediately visible history and |
19382 | 198 svn annotate. |
199 If you are even just slightly uncertain how to revert something then ask on | |
22345 | 200 the mplayer-dev-eng mailing list. |
15227
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
201 |
18841 | 202 |
18840 | 203 10. Reverting local changes |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
204 |
18840 | 205 svn revert <filename(s)> |
14806
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
206 |
18706 | 207 In case you made a lot of local changes to a file and want to start over |
18840 | 208 with a fresh checkout of that file, you can use 'svn revert <filename(s)>'. |
18706 | 209 NOTE: This has nothing to do with reverting changes on the Subversion |
210 server! It only reverts changes that were not committed yet. If you need | |
211 to revert a broken commit, see 9. | |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
212 |
18841 | 213 |
18840 | 214 11. Changing commit messages |
18764
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
215 |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
216 svn propedit svn:log --revprop -r <revision> |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
217 |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
218 If your commit message is too short or not explanatory enough, you can edit |
18845 | 219 it afterwards with 'svn propedit'. |
18764
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
220 |
18841 | 221 |
18840 | 222 Contact the project admins <root at mplayerhq dot hu> if you have technical |
18706 | 223 problems with the Subversion server. |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
224 |
2200 | 225 |
226 | |
227 II. POLICY / RULES: | |
228 =================== | |
229 | |
13288 | 230 1. You must not commit code which breaks MPlayer! (Meaning unfinished but |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
231 enabled code which breaks compilation or compiles but does not work.) |
13288 | 232 You can commit unfinished stuff (for testing etc), but it must be disabled |
233 (#ifdef etc) by default so it does not interfere with other developers' | |
234 work. | |
2200 | 235 |
18841 | 236 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
237 2. You don't have to over-test things. If it works for you, and you think it |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
238 should work for others, too, then commit. If your code has problems |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
239 (portability, exploits compiler bugs, unusual environment etc) they will be |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
240 reported and eventually fixed. |
2200 | 241 |
18841 | 242 |
13288 | 243 3. Do not commit unrelated changes together, split them into self-contained |
22511
6fb4b3944764
Clarify that commits should not be split arbitrarily by file/directory.
diego
parents:
22510
diff
changeset
|
244 pieces, but not smaller. Do not split commits by files or directories, |
6fb4b3944764
Clarify that commits should not be split arbitrarily by file/directory.
diego
parents:
22510
diff
changeset
|
245 keep related changes together. |
2200 | 246 |
18841 | 247 |
17578 | 248 4. Do not change behavior of the program (renaming options etc) or |
17579
f1ce086b5eed
Clarify feature removal policy: it must be approved on the mailing list.
rathann
parents:
17578
diff
changeset
|
249 remove functionality from the code without approval in a discussion on |
f1ce086b5eed
Clarify feature removal policy: it must be approved on the mailing list.
rathann
parents:
17578
diff
changeset
|
250 the mplayer-dev-eng mailing list. |
12024 | 251 |
18841 | 252 |
13288 | 253 5. Do not commit changes to the build system (Makefiles, configure script) |
22510 | 254 which change behavior, defaults etc, without asking first. The same |
13288 | 255 applies to compiler warning fixes, trivial looking fixes and to code |
256 maintained by other developers. We usually have a reason for doing things | |
257 the way we do. Send your changes as patches to the mplayer-dev-eng mailing | |
258 list, and if the code maintainers say OK, you may commit. This does not | |
259 apply to files you wrote and/or maintain. | |
260 | |
18841 | 261 |
13288 | 262 6. We refuse source indentation and other cosmetic changes if they are mixed |
263 with functional changes, such commits will be rejected and removed. Every | |
264 developer has his own indentation style, you should not change it. Of course | |
265 if you (re)write something, you can use your own style... (Many projects | |
266 force a given indentation style - we don't.) If you really need to make | |
267 indentation changes (try to avoid this), separate them strictly from real | |
268 changes. | |
12024 | 269 |
270 NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, | |
13288 | 271 do NOT change the indentation of the inner part (don't move it to the right)! |
2200 | 272 |
18841 | 273 |
13288 | 274 7. Always fill out the commit log message. Describe in a few lines what you |
275 changed and why. You can refer to mailing list postings if you fix a | |
276 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. | |
2200 | 277 |
18841 | 278 |
13288 | 279 8. If you apply a patch by someone else, include the name and email address in |
18660 | 280 the log message. Since the mplayer-cvslog mailing list is publicly |
13288 | 281 archived you should add some spam protection to the email address. Send an |
282 answer to mplayer-dev-eng (or wherever you got the patch from) saying that | |
17054 | 283 you applied the patch. If the patch contains a documentation change, commit |
284 that as well; do not leave it to the documentation maintainers. | |
2200 | 285 |
18841 | 286 |
13288 | 287 9. Do NOT commit to code actively maintained by others without permission. Send |
288 a patch to mplayer-dev-eng instead. | |
12107
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
289 |
18841 | 290 |
18660 | 291 10. Subscribe to the mplayer-cvslog mailing list. The diffs of all commits |
12107
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
292 are sent there and reviewed by all the other developers. Bugs and possible |
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
293 improvements or general questions regarding commits are discussed there. We |
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
294 expect you to react if problems with your code are uncovered. |
12024 | 295 |
18841 | 296 |
13288 | 297 11. Update the documentation if you change behavior or add features. If you are |
298 unsure how best to do this, send a patch to mplayer-docs, the documentation | |
299 maintainers will review and commit your stuff. | |
300 | |
18841 | 301 |
20783
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
302 12. Always send a patch to the mplayer-dev-eng mailing list before committing |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
303 if you suspect that the change is going to be controversial. Based on past |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
304 experience, these changes are likely to be controversial: |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
305 - feature removal, even if obsolete |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
306 - changes to "special" output messages (like the "Core dumped ;)" message) |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
307 - verbosity changes from default (info) level |
22510 | 308 - changes to "historical" parts of docs and web pages |
20783
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
309 - use of internal or external libraries |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
310 |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
311 |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
312 13. Try to keep important discussions and requests (also) on the |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
313 mplayer-dev-eng mailing list, so that all developers can benefit from them. |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
314 IRC is good for quick discussions, but nobody is there 24/7. |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
315 |
dc1a1ff6c7d9
Updated for controversial changes and irc-only decisions
rtogni
parents:
19662
diff
changeset
|
316 |
12099 | 317 Also read DOCS/tech/patches.txt !!!! |
5415 | 318 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
319 We think our rules are not too hard. If you have comments, contact us. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
320 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
321 |
3258 | 322 |
18827 | 323 III. Beginners Guide |
3258 | 324 ==================== |
18828 | 325 |
326 The typical flow of development would be: | |
327 | |
328 1. Check out the source: | |
329 | |
330 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ devel | |
331 | |
18841 | 332 |
18828 | 333 2. Make your changes. |
334 | |
18841 | 335 |
18828 | 336 3. Create a patch: |
337 | |
18840 | 338 Run 'svn diff' from the root of the source tree, like this: |
18828 | 339 |
340 cd devel | |
341 svn diff > ../my_changes.patch | |
342 | |
343 If you have made several changes, but only want to submit one for review | |
344 by other developers, you can specify the filename(s), for example: | |
345 | |
346 svn diff mplayer.c > ../major_cleanup.patch | |
347 | |
18841 | 348 |
18828 | 349 4. Check the patch: |
350 | |
351 Check out another, clean source tree and verify your patch: | |
352 | |
353 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ clean | |
354 cd clean | |
355 patch -p0 --dry-run < ../my_changes.patch | |
356 | |
357 If there are no errors, you can apply your patch: | |
358 | |
359 patch -p0 < ../my_changes.patch | |
360 | |
361 After that, verify that MPlayer still builds correctly with your patch | |
362 applied. Also, be sure that your patch meets our policy as described in | |
363 section II, specifically rules 1 to 6, before you continue submitting | |
364 the patch. | |
365 | |
18841 | 366 |
18828 | 367 5. Submit the patch: |
368 | |
369 Send an e-mail to the mplayer-dev-eng mailing list. Describe what your | |
370 patch does and why, and attach the patch file for review by others. | |
371 | |
18841 | 372 |
18828 | 373 6. During the review process, incorporate all suggested fixes. Go to step 2 |
374 repeatedly until there is nothing more to do for step 6. Of course, if | |
375 you don't agree with certain suggestions, things can be discussed on | |
376 the mailing list in a polite manner. | |
377 | |
18841 | 378 |
18828 | 379 7. Commit the patch: |
380 | |
381 If your patch is accepted, double check if your source tree contains the | |
18840 | 382 most recent version of your patch with 'svn diff'! After verifying that |
383 you met these conditions, commit with: | |
18828 | 384 |
18840 | 385 svn commit <filename(s)> |
18828 | 386 |
387 Go to step 2 ad infinitum until MPlayer is the perfect media player ;) | |
388 | |
18841 | 389 |
18828 | 390 Note: If you are listed as the maintainer for a particular piece of code, |
391 you can skip step 5 and 6 if your patch _only_ applies to the code you | |
392 maintain. If it touches other code or is otherwise very intrusive, please | |
393 post it to mplayer-dev-eng first. |