Mercurial > mplayer.hg
annotate DOCS/tech/cvs-howto.txt @ 17578:22632c215d59
Clarify policy on feature removal.
(recommitted patch by Diego)
author | rathann |
---|---|
date | Fri, 10 Feb 2006 18:10:19 +0000 |
parents | 6ae6b30282da |
children | f1ce086b5eed |
rev | line source |
---|---|
2200 | 1 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
2 About CVS write access: |
2200 | 3 ~~~~~~~~~~~~~~~~~~~~~~~ |
4 | |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
5 Before everything else, you should know how to use CVS properly. CVS comes with |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
6 some documentation, as usual |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
7 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
8 cvs --help |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
9 man cvs |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
10 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
11 are a good start. The most comprehensive manual is the book "Version Management |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
12 with CVS" by Per Cederqvist. It may be available on your system via |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
13 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
14 info cvs |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
15 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
16 or online at |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
17 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
18 http://www.cvshome.org/docs/manual/ |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
19 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
20 Another very good resource is "The CVS Book - Open Source Development with CVS" |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
21 by Karl Fogel and Moshe Bar. It is also available online: |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
22 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
23 http://cvsbook.red-bean.com/ |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
24 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
25 Consult these resources whenever you have problems, they are quite exhaustive. |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
26 What follows now are MPlayer specific guidelines. |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
27 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
28 |
2200 | 29 I. TECH SIDE: |
30 ============= | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
31 |
2200 | 32 1. Changing password: |
33 | |
34 As you probably got a restricted CVS-only shell, it's not trivial: | |
35 | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
36 ssh LOGIN@mplayerhq.hu passwd |
12024 | 37 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
38 Replace LOGIN with your login name. Leave 'passwd' unchanged, it's a command. |
12024 | 39 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
40 Note: If you need a real shell for something, tell A'rpi. |
2200 | 41 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
42 2. Checking out development source tree: |
12024 | 43 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
44 export CVS_RSH=ssh |
11679
16c01dbca208
Pruning empty directories is a good idea and even better is using the
diego
parents:
11395
diff
changeset
|
45 cvs -z3 -d:ext:LOGIN@mplayerhq.hu:/cvsroot/mplayer co -P main |
12024 | 46 |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
47 Replace LOGIN with your login name. |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
48 NOTE: cvs -d:pserver: mode doesn't allow writing, even with password! |
12024 | 49 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
50 3. Committing changes: |
2200 | 51 |
13288 | 52 cvs -z3 update -dPA |
53 cvs -z3 commit filename(s) | |
12024 | 54 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
55 Do not use comments such as: "bug fix." or "files changed" or "dunno". |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
56 You don't have to include the filename in the comment, as comments are linked |
12099 | 57 to files. If you have made several independent changes, commit them |
13288 | 58 separately, not at the same time. You will be prompted for a comment in an |
59 editor (see 'cvs -e', usually vi). | |
12024 | 60 |
2200 | 61 4. Adding new files/dirs: |
62 | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
63 cvs add filename/dirname |
13288 | 64 cvs commit filename |
65 | |
14059
384ae6f896cf
Explain how (not) to handle execute permissions and binary files.
diego
parents:
13288
diff
changeset
|
66 Directories are added immediately, no commit necessary. Make sure you do not |
384ae6f896cf
Explain how (not) to handle execute permissions and binary files.
diego
parents:
13288
diff
changeset
|
67 wrongly commit non-executable files with execute permissions set as this has |
384ae6f896cf
Explain how (not) to handle execute permissions and binary files.
diego
parents:
13288
diff
changeset
|
68 to be fixed manually in the repository. Binary files must be added with |
384ae6f896cf
Explain how (not) to handle execute permissions and binary files.
diego
parents:
13288
diff
changeset
|
69 'cvs add -kb'. |
12024 | 70 |
2200 | 71 5. Removing files: |
72 | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
73 rm filename |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
74 cvs remove filename |
13288 | 75 cvs commit filename |
12024 | 76 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
77 6. Checking changes: |
12024 | 78 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
79 cvs -z3 diff -u filename(s) |
12024 | 80 |
13288 | 81 Doublecheck your changes before committing to avoid trouble later on. |
82 This way you will see if your patch has debug stuff or indentation | |
83 changes and you can fix it before committing and triggering flames. | |
12024 | 84 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
85 7. Checking changelog: |
2200 | 86 |
12024 | 87 cvs -z3 log filename(s) |
13288 | 88 cvs -z3 annotate filename(s) |
89 | |
90 You may also find viewcvs, a web frontend for CVS helpful. It's often more | |
91 comfortable than using cvs log, cvs annotate and cvs diff. Find it here: | |
92 http://www.mplayerhq.hu/cgi-bin/cvsweb.cgi/main | |
12024 | 93 |
9537
5476bc1c5cf6
Empty directories can only be removed by the CVS admin.
diego
parents:
9263
diff
changeset
|
94 8. Renaming/moving files or content of files, removing empty directories: |
2200 | 95 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
96 You CANNOT do that. Ask the CVS server admin (A'rpi) to do it! |
13288 | 97 Do NOT remove & readd a file - it will kill the changelog!!!! |
2200 | 98 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
99 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
|
100 reason and discuss it on the mplayer-dev-eng mailing list first. It will make |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
101 those changes untraceable! |
5415 | 102 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
103 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
|
104 so try to avoid them. |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
105 |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
106 9. Reverting broken commits |
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
107 |
15227
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
108 Should you commit something really broken, notice it quickly and wish to undo |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
109 it completely, the 'cvs admin -o' command can be used as a last resort. This |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
110 command removes entries from the revision history of a file. For the corner |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
111 case of removing the last revision (and only then!) this amounts to reverting |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
112 a commit. The HEAD version is not affected by removing revisions that came |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
113 before, only revision history will be lost and holes left in the revision |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
114 numbering. ONLY EVER use this command to delete the LAST revision of a file. |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
115 |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
116 In short, if you use this improperly you can wreak permanent havoc. Employ it |
167085fd11af
'cvs admin -o' is dangerous and should be handled with extra care.
diego
parents:
14856
diff
changeset
|
117 only if you are completely sure of what you are doing. |
12025
124734dc7c66
Explain why 'cvs admin' should only be used on the last revision of a file.
diego
parents:
12024
diff
changeset
|
118 |
124734dc7c66
Explain why 'cvs admin' should only be used on the last revision of a file.
diego
parents:
12024
diff
changeset
|
119 Assuming that 1.123 is the last revision |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
120 |
12024 | 121 cvs -z3 admin -o1.123 filename |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
122 |
12025
124734dc7c66
Explain why 'cvs admin' should only be used on the last revision of a file.
diego
parents:
12024
diff
changeset
|
123 will remove revision 1.123, thus reverting the file back to revision 1.122. |
124734dc7c66
Explain why 'cvs admin' should only be used on the last revision of a file.
diego
parents:
12024
diff
changeset
|
124 |
14806
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
125 10. RSA authentication |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
126 |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
127 Since mplayerhq.hu uses ssh.com and not OpenSSH you will have to convert your |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
128 OpenSSH RSA keys to IETF SECSH format with |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
129 |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
130 ssh-keygen -e |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
131 |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
132 if you want to use RSA authentication. See ssh(1) and ssh-keygen(1) for |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
133 details. |
6abe4fb845ff
mphq uses ssh.com, explain RSA key generation for it.
diego
parents:
14059
diff
changeset
|
134 |
11395
5484bc13e90a
Some notes about general CVS documentation added, new 'cvs admin' section
diego
parents:
9537
diff
changeset
|
135 |
14856 | 136 Contact the project admin <root at mplayerhq dot hu> if you have technical |
137 problems with the CVS server. | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
138 |
2200 | 139 |
140 | |
141 II. POLICY / RULES: | |
142 =================== | |
143 | |
13288 | 144 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
|
145 enabled code which breaks compilation or compiles but does not work.) |
13288 | 146 You can commit unfinished stuff (for testing etc), but it must be disabled |
147 (#ifdef etc) by default so it does not interfere with other developers' | |
148 work. | |
2200 | 149 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
150 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
|
151 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
|
152 (portability, exploits compiler bugs, unusual environment etc) they will be |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
153 reported and eventually fixed. |
2200 | 154 |
13288 | 155 3. Do not commit unrelated changes together, split them into self-contained |
156 pieces. | |
2200 | 157 |
17578 | 158 4. Do not change behavior of the program (renaming options etc) or |
159 remove functionality from the code without first discussing it | |
160 on the mplayer-dev-eng mailing list. | |
12024 | 161 |
13288 | 162 5. Do not commit changes to the build system (Makefiles, configure script) |
163 which change behaviour, defaults etc, without asking first. The same | |
164 applies to compiler warning fixes, trivial looking fixes and to code | |
165 maintained by other developers. We usually have a reason for doing things | |
166 the way we do. Send your changes as patches to the mplayer-dev-eng mailing | |
167 list, and if the code maintainers say OK, you may commit. This does not | |
168 apply to files you wrote and/or maintain. | |
169 | |
170 6. We refuse source indentation and other cosmetic changes if they are mixed | |
171 with functional changes, such commits will be rejected and removed. Every | |
172 developer has his own indentation style, you should not change it. Of course | |
173 if you (re)write something, you can use your own style... (Many projects | |
174 force a given indentation style - we don't.) If you really need to make | |
175 indentation changes (try to avoid this), separate them strictly from real | |
176 changes. | |
12024 | 177 |
178 NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, | |
13288 | 179 do NOT change the indentation of the inner part (don't move it to the right)! |
2200 | 180 |
13288 | 181 7. Always fill out the commit log message. Describe in a few lines what you |
182 changed and why. You can refer to mailing list postings if you fix a | |
183 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. | |
2200 | 184 |
13288 | 185 8. If you apply a patch by someone else, include the name and email address in |
186 the CVS log message. Since the mplayer-cvslog mailing list is publicly | |
187 archived you should add some spam protection to the email address. Send an | |
188 answer to mplayer-dev-eng (or wherever you got the patch from) saying that | |
17054 | 189 you applied the patch. If the patch contains a documentation change, commit |
190 that as well; do not leave it to the documentation maintainers. | |
2200 | 191 |
13288 | 192 9. Do NOT commit to code actively maintained by others without permission. Send |
193 a patch to mplayer-dev-eng instead. | |
12107
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
194 |
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
195 10. Subscribe to the mplayer-cvslog mailing list. The diffs of all CVS commits |
bc89ddda34b8
Developers should subscribe to mplayer-cvslog, mention mplayer-docs.
diego
parents:
12099
diff
changeset
|
196 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
|
197 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
|
198 expect you to react if problems with your code are uncovered. |
12024 | 199 |
13288 | 200 11. Update the documentation if you change behavior or add features. If you are |
201 unsure how best to do this, send a patch to mplayer-docs, the documentation | |
202 maintainers will review and commit your stuff. | |
203 | |
204 12. Revert a commit ONLY in case of a big blunder like committing something not | |
205 intended to be committed or committing a wrong file, the wrong version of a | |
206 patch, cosmetics or broken code and you are going to recommit the right | |
207 thing immediately. | |
208 | |
209 Never revert changes made a long time ago or buggy code. Fix it in the | |
210 normal way instead. | |
211 | |
12099 | 212 Also read DOCS/tech/patches.txt !!!! |
5415 | 213 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
214 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
|
215 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
216 |
3258 | 217 |
218 III. Beginners Guide by David Holm | |
219 ==================== | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
220 |
3258 | 221 When I first got CVS write access I got banned after only a few hours |
222 because I didn't fully understand this documentation. This part is for | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
223 those of you who have just got CVS write access and want to avoid the |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
224 most common pitfalls leading to CVS ban. |
3258 | 225 I will introduce a step-by-step guide explaining how I'm making sure |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
226 that my CVS commits are proper and won't get me banned. |
3258 | 227 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
228 1. You should set up two directoress for MPlayer, one which contains the stable |
3258 | 229 version and has the :ext: option instead of :pserver: in CVS/Root. |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
230 The other should be your development directory and have the CVS/Root set to |
3258 | 231 :pserver: instead of :ext:, that way you can't commit development code |
232 by accident (since only :ext: allows writes). | |
233 This is my setup: | |
234 ~/mplayer | |
235 /main | |
236 /main.dev | |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
237 NOTE: I'll use these directory names from here on in the guide, what you |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
238 call your directories is entirely up to you. This is _only_ an example. |
3258 | 239 |
240 2. When you are satisfied with the changes in "main.dev" and think you are | |
241 ready to commit the changes to CVS start by doing the following in the | |
242 "~/mplayer" dir": | |
243 diff -Nur -x "CVS" -x ".*" main main.dev > dev2stable | |
244 dev2stable is the filename for the patchfile, it doesn't matter what you | |
245 call it. | |
12024 | 246 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
247 3. Now comes one of the tricky parts, editing the patch. I prefer using mcedit |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
248 (comes with Midnight Commander) since it does syntax highlighting in patches |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
249 (= it uses colors to identify lines =), But most ASCII editors should do |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
250 (meaning don't use Star Office and save it as a Star Office document for |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
251 instance ;) I will try to explain this as good as I can. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
252 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
253 Read through the patch and remove all occurrences of: |
3258 | 254 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
255 * diff -Nur.... that are affecting files YOU have NOT modified. These |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
256 occur when either main or main.dev are a different version (not checked |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
257 out at the same time) |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
258 EVERYTHING from the diff -Nur... line until the next diff -Nur... line |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
259 are changes to the file specified after the diff options, and ONLY that |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
260 file. |
12024 | 261 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
262 * Lines containing "Binary files..." if you add the 'a' switch to -N(a)ur |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
263 binary files will be added to the patch as well, making it huge and |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
264 putting a lot of unnecessary data in it (since you seldom commit any |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
265 binaries). |
12024 | 266 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
267 * If you find changes within a diff block that you don't want to commit |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
268 you can delete them if they are the only changes ranging from the |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
269 @@ -x,y +x,y @@ until the line before the next @@ -x,y +x,y @@. You |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
270 _cannot_ remove single lines after a @@ -x,y +x,y @@ because that will |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
271 break the patch!. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
272 Example: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
273 ... |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
274 @@ -15,34 +15,6 @@ |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
275 - old_option; |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
276 + new_option; |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
277 @@ -65,13 +65,3 @@ |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
278 ... |
12024 | 279 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
280 OK: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
281 ... |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
282 @@ -65,13 +65,3 @@ |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
283 ... |
12024 | 284 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
285 Will break patch: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
286 ... |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
287 @@ -15,34 +15,6 @@ |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
288 old_option; |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
289 @@ -65,13 +65,3 @@ |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
290 ... |
12024 | 291 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
292 When I end up in a situation where I have to remove just some lines from |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
293 a block, I leave it alone, remember (write down) which file it is in and |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
294 then edit the file in "main" after I've applied the patch. |
12024 | 295 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
296 * Now it's time for applying the patch to the "main" (stable) directory. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
297 This should be done in two steps: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
298 1. enter "main" and run |
12024 | 299 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
300 patch -p1 --dry-run < ../dev2stable |
12024 | 301 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
302 -p1 means that you are one level deep (that you have entered the |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
303 "main" directory and that should be stripped when patching, if you |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
304 run it from "~/mplayer" you would use -p0). |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
305 --dry-run means that patch does everything it normally does but |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
306 without modifying ANY files. This is a great way of testing whether |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
307 your patch works or not. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
308 "../dev2stable" is your patchfile. (don't forget the '<') |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
309 If the dry run fails, check the line it failed on and figure out |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
310 why it failed, make a new patch and try again. |
12024 | 311 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
312 2. OK, you finally have a working patch, remove --dry-run, patch "main" |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
313 and you are done with the patching part =). |
12024 | 314 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
315 4. It's almost time for the final step, committing the changes. But first you |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
316 MUST make sure your changes compile without breaking anything and that it |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
317 follows the Policy mentioned in section 2. (Read it until your eyes are |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
318 bleeding if you want to keep CVS access!) |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
319 Don't worry about object files etc that will be created in your "main" dir, |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
320 they won't be sent to CVS on a commit, you must use the add command to add |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
321 new files (discuss it on dev-eng before adding new files!). |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
322 Now to make sure your additions follow policy do the following on every file |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
323 you will commit: |
12024 | 324 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
325 cvs -z3 diff -u <filename> > <filename.d> |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
326 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
327 Of course the output file (<filename.d>) can have any name you want. This |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
328 will create a file showing the differences between the file on CVS and your |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
329 updated local file. |
3258 | 330 I will explain some of the policy rules I had a hard time understanding: |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
331 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
332 II.5: This means that if for instance you have lines in <filename.d> that |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
333 look something like this: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
334 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
335 - |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
336 + |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
337 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
338 That means you have added or removed tabs or spaces on that line. |
12904 | 339 That qualifies as a cosmetic change and is disallowed. Edit the |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
340 file and put back/remove the added/removed tabs/spaces. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
341 Rediff the file and make sure the cosmetic changes are fixed. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
342 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
343 II.6: Make sure you read and understand this properly before committing |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
344 anything. Commit one file at a time! |
3258 | 345 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
346 5. OK, you have a working patch following the CVS policy, excellent work. Now |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
347 for the final step, committing. This is really simple. Just run the |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
348 following command in "main" for each file you want to commit: |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
349 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
350 cvs -z3 commit -m "<comment (changes)>" <filename> |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
351 cvs -z3 commit <filename> |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
352 |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
353 The latter will bring up your default text editor for writing comments (I |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
354 prefer this method). |
12024 | 355 |
7904
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
356 You are done, congratulations. If you are certain you have followed all of the |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
357 policy you shouldn't have any trouble with the CVS maintainers at all. |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
358 At first I thought the policy was too strict, but I discussed it with A'rpi and |
98168d30f67d
Spellchecked, reworded, reformatted, small additions and corrections.
diego
parents:
5415
diff
changeset
|
359 he made some very good points, so don't complain. |