Mercurial > mplayer.hg
annotate DOCS/tech/svn-howto.txt @ 18840:3b42c599ea09
Rewrite and extend the Subversion guidelines.
author | diego |
---|---|
date | Wed, 28 Jun 2006 17:02:56 +0000 |
parents | 55ebe20fadbc |
children | 3f59edf39ea2 |
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 |
18840 | 33 I. BASICS: |
34 ========== | |
35 | |
36 1. Checking out the source tree: | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
37 |
18840 | 38 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ <target> |
2200 | 39 |
18840 | 40 This will put the MPlayer sources into the directory <target>. |
2200 | 41 |
18840 | 42 2. Updating the source tree to the latest revision: |
18706 | 43 |
44 svn update | |
12024 | 45 |
18840 | 46 pulls in the latest changes from the repository to your working directory. |
47 | |
48 3. Adding/removing files/directories: | |
49 | |
50 svn add <filename/dirname> | |
51 svn delete <filename/dirname> | |
52 | |
53 Subversion needs to get notified of all changes you make to your working | |
54 directory. | |
55 | |
56 4. Showing modifications: | |
57 | |
58 svn diff <filename(s)> | |
59 | |
60 will show all local modifications in your working directory as unified diff. | |
61 | |
62 5. Inspecting the changelog: | |
63 | |
64 svn log <filename(s)> | |
65 | |
66 You may also find viewvc, a web frontend for Subversion, helpful. It's often | |
67 more comfortable than using 'svn log' and 'svn diff'. Find it here: | |
68 http://svn.mplayerhq.hu/mplayer/trunk/ | |
69 | |
70 6. Checking source tree status: | |
71 | |
72 svn status | |
73 | |
74 detects all the changes you made and lists what actions will be taken in case | |
75 of a commit (additions, modifications, deletions, etc.). | |
76 | |
77 7. Committing: | |
2200 | 78 |
18767 | 79 svn update |
18840 | 80 |
81 Run 'svn update' before committing to make sure there were no changes to the | |
82 files you worked on in the meantime. Afterwards look at the output of | |
83 | |
84 svn diff <filename(s)> | |
12024 | 85 |
18840 | 86 to doublecheck your changes before committing to avoid trouble later on. All |
87 experienced developers do this on each and every commit, no matter how small. | |
88 Every one of them has been saved from looking like a fool by this many times. | |
89 It's very easy for stray debug output or cosmetic modifications to slip in, | |
90 please avoid problems through this extra level of scrutiny. | |
91 | |
92 Once you have made sure everything is fine | |
93 | |
94 svn commit <filename(s)> | |
95 | |
96 propagates your stuff to the repository. If you have made several independent | |
97 changes, commit them separately, not at the same time. | |
98 | |
99 When prompted for a password, type the password you got assigned by the | |
100 project admins. By default, Subversion caches all authentication tokens. | |
101 This behaviour can be disabled by setting both 'store-passwords' and | |
18706 | 102 'store-auth-creds' to "no" in ~/.subversion/config. You might need to remove |
103 previous cache files, which are located in ~/.subversion/auth, by hand. | |
12024 | 104 |
18840 | 105 You will be prompted for a log message in an editor, which is either specified |
106 by --editor-cmd on the command line, set in your personal configuration file | |
107 (~/.subversion/config) or set by one of the following environment variables: | |
108 SVN_EDITOR, VISUAL or EDITOR. | |
12024 | 109 |
18840 | 110 Log messages should be concise but descriptive. Explain why you made a change, |
111 what you did will be obvious from the changes themselves most of the time. | |
112 Saying just "bug fix" or "10l" is bad. Remember that people of varying skill | |
113 levels look at and educate themselves while reading through your code. Don't | |
114 include filenames in log messages, Subversion provides that information. | |
18706 | 115 |
18840 | 116 8. Renaming/moving files or contents of files: |
13288 | 117 |
18840 | 118 svn move <source> <destination> |
119 svn commit <source> <destination> | |
2200 | 120 |
18706 | 121 Do not move or rename files before discussing it on the mplayer-dev-eng |
122 mailing list first! | |
2200 | 123 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
124 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
|
125 reason and discuss it on the mplayer-dev-eng mailing list first. It will make |
18840 | 126 those changes hard to trace. |
5415 | 127 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
128 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
|
129 so try to avoid them. |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
130 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
131 9. Reverting broken commits |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
132 |
18706 | 133 There is no Subversion equivalent of the 'cvs admin -o' command. Instead, |
134 be very careful about what you commit! If somehow you broke something, | |
135 revert the changes locally and re-commit with a proper commit message. | |
18840 | 136 You may want to use 'svn cat -r<revision> <filename>' to inspect an older |
18706 | 137 revision. |
15227
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
138 |
18840 | 139 10. Reverting local changes |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
140 |
18840 | 141 svn revert <filename(s)> |
14806
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
142 |
18706 | 143 In case you made a lot of local changes to a file and want to start over |
18840 | 144 with a fresh checkout of that file, you can use 'svn revert <filename(s)>'. |
18706 | 145 NOTE: This has nothing to do with reverting changes on the Subversion |
146 server! It only reverts changes that were not committed yet. If you need | |
147 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
|
148 |
18840 | 149 11. Changing commit messages |
18764
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
150 |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
151 svn propedit svn:log --revprop -r <revision> |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
152 |
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
153 If your commit message is too short or not explanatory enough, you can edit |
18840 | 154 it afterwards with svn' propedit'. |
18764
5b89070daa50
add command for changing commit messages after the commit took place.
ivo
parents:
18706
diff
changeset
|
155 |
18840 | 156 Contact the project admins <root at mplayerhq dot hu> if you have technical |
18706 | 157 problems with the Subversion server. |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
158 |
2200 | 159 |
160 | |
161 II. POLICY / RULES: | |
162 =================== | |
163 | |
13288 | 164 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
|
165 enabled code which breaks compilation or compiles but does not work.) |
13288 | 166 You can commit unfinished stuff (for testing etc), but it must be disabled |
167 (#ifdef etc) by default so it does not interfere with other developers' | |
168 work. | |
2200 | 169 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
170 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
|
171 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
|
172 (portability, exploits compiler bugs, unusual environment etc) they will be |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
173 reported and eventually fixed. |
2200 | 174 |
13288 | 175 3. Do not commit unrelated changes together, split them into self-contained |
176 pieces. | |
2200 | 177 |
17578 | 178 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
|
179 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
|
180 the mplayer-dev-eng mailing list. |
12024 | 181 |
13288 | 182 5. Do not commit changes to the build system (Makefiles, configure script) |
183 which change behaviour, defaults etc, without asking first. The same | |
184 applies to compiler warning fixes, trivial looking fixes and to code | |
185 maintained by other developers. We usually have a reason for doing things | |
186 the way we do. Send your changes as patches to the mplayer-dev-eng mailing | |
187 list, and if the code maintainers say OK, you may commit. This does not | |
188 apply to files you wrote and/or maintain. | |
189 | |
190 6. We refuse source indentation and other cosmetic changes if they are mixed | |
191 with functional changes, such commits will be rejected and removed. Every | |
192 developer has his own indentation style, you should not change it. Of course | |
193 if you (re)write something, you can use your own style... (Many projects | |
194 force a given indentation style - we don't.) If you really need to make | |
195 indentation changes (try to avoid this), separate them strictly from real | |
196 changes. | |
12024 | 197 |
198 NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, | |
13288 | 199 do NOT change the indentation of the inner part (don't move it to the right)! |
2200 | 200 |
13288 | 201 7. Always fill out the commit log message. Describe in a few lines what you |
202 changed and why. You can refer to mailing list postings if you fix a | |
203 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. | |
2200 | 204 |
13288 | 205 8. If you apply a patch by someone else, include the name and email address in |
18660 | 206 the log message. Since the mplayer-cvslog mailing list is publicly |
13288 | 207 archived you should add some spam protection to the email address. Send an |
208 answer to mplayer-dev-eng (or wherever you got the patch from) saying that | |
17054 | 209 you applied the patch. If the patch contains a documentation change, commit |
210 that as well; do not leave it to the documentation maintainers. | |
2200 | 211 |
13288 | 212 9. Do NOT commit to code actively maintained by others without permission. Send |
213 a patch to mplayer-dev-eng instead. | |
12107
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
214 |
18660 | 215 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
|
216 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
|
217 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
|
218 expect you to react if problems with your code are uncovered. |
12024 | 219 |
13288 | 220 11. Update the documentation if you change behavior or add features. If you are |
221 unsure how best to do this, send a patch to mplayer-docs, the documentation | |
222 maintainers will review and commit your stuff. | |
223 | |
12099 | 224 Also read DOCS/tech/patches.txt !!!! |
5415 | 225 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
226 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
|
227 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
228 |
3258 | 229 |
18827 | 230 III. Beginners Guide |
3258 | 231 ==================== |
18828 | 232 |
233 The typical flow of development would be: | |
234 | |
235 1. Check out the source: | |
236 | |
237 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ devel | |
238 | |
239 2. Make your changes. | |
240 | |
241 3. Create a patch: | |
242 | |
18840 | 243 Run 'svn diff' from the root of the source tree, like this: |
18828 | 244 |
245 cd devel | |
246 svn diff > ../my_changes.patch | |
247 | |
248 If you have made several changes, but only want to submit one for review | |
249 by other developers, you can specify the filename(s), for example: | |
250 | |
251 svn diff mplayer.c > ../major_cleanup.patch | |
252 | |
253 4. Check the patch: | |
254 | |
255 Check out another, clean source tree and verify your patch: | |
256 | |
257 svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ clean | |
258 cd clean | |
259 patch -p0 --dry-run < ../my_changes.patch | |
260 | |
261 If there are no errors, you can apply your patch: | |
262 | |
263 patch -p0 < ../my_changes.patch | |
264 | |
265 After that, verify that MPlayer still builds correctly with your patch | |
266 applied. Also, be sure that your patch meets our policy as described in | |
267 section II, specifically rules 1 to 6, before you continue submitting | |
268 the patch. | |
269 | |
270 5. Submit the patch: | |
271 | |
272 Send an e-mail to the mplayer-dev-eng mailing list. Describe what your | |
273 patch does and why, and attach the patch file for review by others. | |
274 | |
275 6. During the review process, incorporate all suggested fixes. Go to step 2 | |
276 repeatedly until there is nothing more to do for step 6. Of course, if | |
277 you don't agree with certain suggestions, things can be discussed on | |
278 the mailing list in a polite manner. | |
279 | |
280 7. Commit the patch: | |
281 | |
282 If your patch is accepted, double check if your source tree contains the | |
18840 | 283 most recent version of your patch with 'svn diff'! After verifying that |
284 you met these conditions, commit with: | |
18828 | 285 |
18840 | 286 svn commit <filename(s)> |
18828 | 287 |
288 Go to step 2 ad infinitum until MPlayer is the perfect media player ;) | |
289 | |
290 Note: If you are listed as the maintainer for a particular piece of code, | |
291 you can skip step 5 and 6 if your patch _only_ applies to the code you | |
292 maintain. If it touches other code or is otherwise very intrusive, please | |
293 post it to mplayer-dev-eng first. |