Commit | Line | Data |
---|---|---|
0549aefb LB |
1 | =for comment |
2 | Consistent formatting of this file is achieved with: | |
3 | perl ./Porting/podtidy pod/perlrepository.pod | |
4 | ||
d7dd28b6 LB |
5 | =head1 NAME |
6 | ||
7 | perlrepository - Using the Perl source repository | |
8 | ||
9 | =head1 SYNOPSIS | |
10 | ||
dc3c3040 | 11 | All of Perl's source code is kept centrally in a Git repository at |
c26da522 LB |
12 | I<perl5.git.perl.org>. The repository contains many Perl revisions from |
13 | Perl 1 onwards and all the revisions from Perforce, the version control | |
14 | system we were using previously. This repository is accessible in | |
15 | different ways. | |
d7dd28b6 LB |
16 | |
17 | The full repository takes up about 80MB of disk space. A check out of | |
7f4ffa9d | 18 | the blead branch (that is, the main development branch, which contains |
6a7cbfe8 LB |
19 | bleadperl, the development version of perl 5) takes up about 160MB of |
20 | disk space (including the repository). A build of bleadperl takes up | |
21 | about 200MB (including the repository and the check out). | |
d7dd28b6 LB |
22 | |
23 | =head1 GETTING ACCESS TO THE REPOSITORY | |
24 | ||
25 | =head2 READ ACCESS VIA THE WEB | |
26 | ||
dc3c3040 GA |
27 | You may access the repository over the web. This allows you to browse |
28 | the tree, see recent commits, subscribe to RSS feeds for the changes, | |
29 | search for particular commits and more. You may access it at: | |
d7dd28b6 LB |
30 | |
31 | http://perl5.git.perl.org/perl.git | |
32 | ||
dc3c3040 GA |
33 | A mirror of the repository is found at: |
34 | ||
35 | http://github.com/github/perl | |
36 | ||
d7dd28b6 LB |
37 | =head2 READ ACCESS VIA GIT |
38 | ||
39 | You will need a copy of Git for your computer. You can fetch a copy of | |
40 | the repository using the Git protocol (which uses port 9418): | |
41 | ||
3b8a5fb0 | 42 | git clone git://perl5.git.perl.org/perl.git perl-git |
d7dd28b6 | 43 | |
f755e97d | 44 | This clones the repository and makes a local copy in the F<perl-git> |
d7dd28b6 LB |
45 | directory. |
46 | ||
47 | If your local network does not allow you to use port 9418, then you can | |
572f57ba | 48 | fetch a copy of the repository over HTTP (this is slower): |
d7dd28b6 | 49 | |
3b8a5fb0 | 50 | git clone http://perl5.git.perl.org/perl.git perl-http |
d7dd28b6 | 51 | |
f755e97d | 52 | This clones the repository and makes a local copy in the F<perl-http> |
d7dd28b6 LB |
53 | directory. |
54 | ||
55 | =head2 WRITE ACCESS TO THE REPOSITORY | |
56 | ||
6acba58e LB |
57 | If you are a committer, then you can fetch a copy of the repository |
58 | that you can push back on with: | |
d7dd28b6 | 59 | |
3482f01a | 60 | git clone ssh://perl5.git.perl.org/perl.git perl-ssh |
d7dd28b6 | 61 | |
8f718e95 | 62 | This clones the repository and makes a local copy in the F<perl-ssh> |
d7dd28b6 LB |
63 | directory. |
64 | ||
c26da522 LB |
65 | If you cloned using the git protocol, which is faster than ssh, then |
66 | you will need to modify your config in order to enable pushing. Edit | |
67 | F<.git/config> where you will see something like: | |
1a0f15d5 YO |
68 | |
69 | [remote "origin"] | |
70 | url = git://perl5.git.perl.org/perl.git | |
71 | ||
72 | change that to something like this: | |
73 | ||
74 | [remote "origin"] | |
3482f01a | 75 | url = ssh://perl5.git.perl.org/perl.git |
d7dd28b6 | 76 | |
184487f0 NC |
77 | You can also set up your user name and e-mail address. For example |
78 | ||
79 | % git config user.name "Leon Brocard" | |
80 | % git config user.email acme@astray.com | |
81 | ||
6acba58e LB |
82 | It is also possible to keep C<origin> as a git remote, and add a new |
83 | remote for ssh access: | |
f6c12373 | 84 | |
dc3c3040 | 85 | % git remote add camel perl5.git.perl.org:/perl.git |
f6c12373 | 86 | |
6acba58e | 87 | This allows you to update your local repository by pulling from |
f755e97d | 88 | C<origin>, which is faster and doesn't require you to authenticate, and |
6acba58e | 89 | to push your changes back with the C<camel> remote: |
f6c12373 VP |
90 | |
91 | % git fetch camel | |
92 | % git push camel | |
93 | ||
6acba58e LB |
94 | The C<fetch> command just updates the C<camel> refs, as the objects |
95 | themselves should have been fetched when pulling from C<origin>. | |
f6c12373 | 96 | |
3482f01a DK |
97 | =head2 A NOTE ON CAMEL AND DROMEDARY |
98 | ||
99 | The committers have SSH access to the two servers that serve | |
333f8875 VP |
100 | C<perl5.git.perl.org>. One is C<perl5.git.perl.org> itself (I<camel>), |
101 | which is the 'master' repository. The second one is | |
102 | C<users.perl5.git.perl.org> (I<dromedary>), which can be used for | |
103 | general testing and development. Dromedary syncs the git tree from | |
104 | camel every few minutes, you should not push there. Both machines also | |
3482f01a DK |
105 | have a full CPAN mirror in /srv/CPAN, please use this. To share files |
106 | with the general public, dromedary serves your ~/public_html/ as | |
333f8875 | 107 | C<http://users.perl5.git.perl.org/~yourlogin/> |
b47aa495 | 108 | |
3482f01a DK |
109 | These hosts have fairly strict firewalls to the outside. Outgoing, only |
110 | rsync, ssh and git are allowed. For http and ftp, you can use | |
111 | http://webproxy:3128 as proxy. Incoming, the firewall tries to detect | |
112 | attacks and blocks IP addresses with suspicious activity. This | |
113 | sometimes (but very rarely) has false positives and you might get | |
114 | blocked. The quickest way to get unblocked is to notify the admins. | |
115 | ||
116 | These two boxes are owned, hosted, and operated by booking.com. You can | |
117 | reach the sysadmins in #p5p on irc.perl.org or via mail to | |
118 | C<perl5-porters@perl.org> | |
119 | ||
d7dd28b6 LB |
120 | =head1 OVERVIEW OF THE REPOSITORY |
121 | ||
6acba58e LB |
122 | Once you have changed into the repository directory, you can inspect |
123 | it. | |
d7dd28b6 | 124 | |
39219fd3 | 125 | After a clone the repository will contain a single local branch, which |
50eca761 | 126 | will be the current branch as well, as indicated by the asterisk. |
39219fd3 YO |
127 | |
128 | % git branch | |
129 | * blead | |
130 | ||
f755e97d | 131 | Using the -a switch to C<branch> will also show the remote tracking |
6acba58e | 132 | branches in the repository: |
39219fd3 | 133 | |
d9847473 | 134 | % git branch -a |
09081495 | 135 | * blead |
d7dd28b6 LB |
136 | origin/HEAD |
137 | origin/blead | |
138 | ... | |
139 | ||
6acba58e LB |
140 | The branches that begin with "origin" correspond to the "git remote" |
141 | that you cloned from (which is named "origin"). Each branch on the | |
142 | remote will be exactly tracked by theses branches. You should NEVER do | |
143 | work on these remote tracking branches. You only ever do work in a | |
144 | local branch. Local branches can be configured to automerge (on pull) | |
145 | from a designated remote tracking branch. This is the case with the | |
146 | default branch C<blead> which will be configured to merge from the | |
147 | remote tracking branch C<origin/blead>. | |
39219fd3 | 148 | |
d7dd28b6 LB |
149 | You can see recent commits: |
150 | ||
c2cf2042 | 151 | % git log |
d7dd28b6 | 152 | |
6acba58e LB |
153 | And pull new changes from the repository, and update your local |
154 | repository (must be clean first) | |
d7dd28b6 LB |
155 | |
156 | % git pull | |
09081495 | 157 | |
6acba58e LB |
158 | Assuming we are on the branch C<blead> immediately after a pull, this |
159 | command would be more or less equivalent to: | |
39219fd3 YO |
160 | |
161 | % git fetch | |
162 | % git merge origin/blead | |
163 | ||
6acba58e LB |
164 | In fact if you want to update your local repository without touching |
165 | your working directory you do: | |
39219fd3 YO |
166 | |
167 | % git fetch | |
168 | ||
6acba58e LB |
169 | And if you want to update your remote-tracking branches for all defined |
170 | remotes simultaneously you can do | |
39219fd3 YO |
171 | |
172 | % git remote update | |
173 | ||
6acba58e LB |
174 | Neither of these last two commands will update your working directory, |
175 | however both will update the remote-tracking branches in your | |
176 | repository. | |
39219fd3 | 177 | |
09081495 LB |
178 | To switch to another branch: |
179 | ||
180 | % git checkout origin/maint-5.8-dor | |
181 | ||
6051489b NC |
182 | To make a local branch of a remote branch: |
183 | ||
184 | % git checkout -b maint-5.10 origin/maint-5.10 | |
185 | ||
09081495 LB |
186 | To switch back to blead: |
187 | ||
188 | % git checkout blead | |
c2cf2042 | 189 | |
39219fd3 YO |
190 | =head2 FINDING OUT YOUR STATUS |
191 | ||
192 | The most common git command you will use will probably be | |
193 | ||
194 | % git status | |
195 | ||
6acba58e LB |
196 | This command will produce as output a description of the current state |
197 | of the repository, including modified files and unignored untracked | |
198 | files, and in addition it will show things like what files have been | |
199 | staged for the next commit, and usually some useful information about | |
200 | how to change things. For instance the following: | |
39219fd3 YO |
201 | |
202 | $ git status | |
203 | # On branch blead | |
204 | # Your branch is ahead of 'origin/blead' by 1 commit. | |
205 | # | |
206 | # Changes to be committed: | |
207 | # (use "git reset HEAD <file>..." to unstage) | |
208 | # | |
209 | # modified: pod/perlrepository.pod | |
210 | # | |
211 | # Changed but not updated: | |
212 | # (use "git add <file>..." to update what will be committed) | |
213 | # | |
214 | # modified: pod/perlrepository.pod | |
215 | # | |
216 | # Untracked files: | |
217 | # (use "git add <file>..." to include in what will be committed) | |
218 | # | |
219 | # deliberate.untracked | |
220 | ||
6acba58e LB |
221 | This shows that there were changes to this document staged for commit, |
222 | and that there were further changes in the working directory not yet | |
223 | staged. It also shows that there was an untracked file in the working | |
224 | directory, and as you can see shows how to change all of this. It also | |
0549aefb LB |
225 | shows that there is one commit on the working branch C<blead> which has |
226 | not been pushed to the C<origin> remote yet. B<NOTE>: that this output | |
227 | is also what you see as a template if you do not provide a message to | |
228 | C<git commit>. | |
7f6effc7 | 229 | |
bdaf0bc6 JV |
230 | Assuming that you'd like to commit all the changes you've just made as a |
231 | a single atomic unit, run this command: | |
232 | ||
233 | % git commit -a | |
234 | ||
235 | (That C<-a> tells git to add every file you've changed to this commit. | |
ea9c0d74 JV |
236 | New files aren't automatically added to your commit when you use C<commit |
237 | -a> If you want to add files or to commit some, but not all of your | |
238 | changes, have a look at the documentation for C<git add>.) | |
bdaf0bc6 | 239 | |
e9360695 | 240 | Git will start up your favorite text editor, so that you can craft a |
bdaf0bc6 JV |
241 | commit message for your change. See L</Commit message> below for more |
242 | information about what makes a good commit message. | |
243 | ||
244 | Once you've finished writing your commit message and exited your editor, | |
245 | git will write your change to disk and tell you something like this: | |
7f6effc7 | 246 | |
7f6effc7 YO |
247 | Created commit daf8e63: explain git status and stuff about remotes |
248 | 1 files changed, 83 insertions(+), 3 deletions(-) | |
249 | ||
bdaf0bc6 JV |
250 | |
251 | If you re-run C<git status>, you should see something like this: | |
7f6effc7 YO |
252 | |
253 | % git status | |
254 | # On branch blead | |
255 | # Your branch is ahead of 'origin/blead' by 2 commits. | |
256 | # | |
257 | # Untracked files: | |
258 | # (use "git add <file>..." to include in what will be committed) | |
259 | # | |
260 | # deliberate.untracked | |
261 | nothing added to commit but untracked files present (use "git add" to track) | |
262 | ||
39219fd3 | 263 | |
6acba58e LB |
264 | When in doubt, before you do anything else, check your status and read |
265 | it carefully, many questions are answered directly by the git status | |
266 | output. | |
39219fd3 | 267 | |
c2cf2042 LB |
268 | =head1 SUBMITTING A PATCH |
269 | ||
270 | If you have a patch in mind for Perl, you should first get a copy of | |
271 | the repository: | |
272 | ||
273 | % git clone git://perl5.git.perl.org/perl.git perl-git | |
274 | ||
275 | Then change into the directory: | |
276 | ||
277 | % cd perl-git | |
278 | ||
6acba58e LB |
279 | Alternatively, if you already have a Perl repository, you should ensure |
280 | that you're on the I<blead> branch, and your repository is up to date: | |
12322d22 A |
281 | |
282 | % git checkout blead | |
283 | % git pull | |
284 | ||
6a7cbfe8 LB |
285 | It's preferable to patch against the latest blead version, since this |
286 | is where new development occurs for all changes other than critical bug | |
287 | fixes. Critical bug fix patches should be made against the relevant | |
7f4ffa9d RS |
288 | maint branches, or should be submitted with a note indicating all the |
289 | branches where the fix should be applied. | |
a44f43ac | 290 | |
6acba58e LB |
291 | Now that we have everything up to date, we need to create a temporary |
292 | new branch for these changes and switch into it: | |
b1fccde5 | 293 | |
a9b05323 | 294 | % git checkout -b orange |
23f8d33e | 295 | |
a9b05323 YO |
296 | which is the short form of |
297 | ||
b1fccde5 LB |
298 | % git branch orange |
299 | % git checkout orange | |
300 | ||
c2cf2042 LB |
301 | Then make your changes. For example, if Leon Brocard changes his name |
302 | to Orange Brocard, we should change his name in the AUTHORS file: | |
303 | ||
304 | % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS | |
305 | ||
306 | You can see what files are changed: | |
307 | ||
308 | % git status | |
f755e97d | 309 | # On branch orange |
c2cf2042 LB |
310 | # Changes to be committed: |
311 | # (use "git reset HEAD <file>..." to unstage) | |
312 | # | |
2699d634 | 313 | # modified: AUTHORS |
c2cf2042 LB |
314 | # |
315 | ||
c2cf2042 LB |
316 | And you can see the changes: |
317 | ||
318 | % git diff | |
319 | diff --git a/AUTHORS b/AUTHORS | |
320 | index 293dd70..722c93e 100644 | |
321 | --- a/AUTHORS | |
322 | +++ b/AUTHORS | |
7df2e4bc | 323 | @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie> |
c2cf2042 LB |
324 | Laszlo Molnar <laszlo.molnar@eth.ericsson.se> |
325 | Leif Huhn <leif@hale.dkstat.com> | |
326 | Len Johnson <lenjay@ibm.net> | |
327 | -Leon Brocard <acme@astray.com> | |
328 | +Orange Brocard <acme@astray.com> | |
329 | Les Peters <lpeters@aol.net> | |
330 | Lesley Binks <lesley.binks@gmail.com> | |
331 | Lincoln D. Stein <lstein@cshl.org> | |
332 | ||
333 | Now commit your change locally: | |
334 | ||
dc3c3040 | 335 | % git commit -a -m 'Rename Leon Brocard to Orange Brocard' |
c2cf2042 LB |
336 | Created commit 6196c1d: Rename Leon Brocard to Orange Brocard |
337 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
338 | ||
dc3c3040 GA |
339 | You can examine your last commit with: |
340 | ||
341 | % git show HEAD | |
342 | ||
343 | and if you are not happy with either the description or the patch | |
c26da522 | 344 | itself you can fix it up by editing the files once more and then issue: |
dc3c3040 GA |
345 | |
346 | % git commit -a --amend | |
347 | ||
c2cf2042 LB |
348 | Now you should create a patch file for all your local changes: |
349 | ||
2af192ee | 350 | % git format-patch origin |
c2cf2042 LB |
351 | 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch |
352 | ||
353 | You should now send an email to perl5-porters@perl.org with a | |
dc3c3040 | 354 | description of your changes, and include this patch file as an |
333f8875 VP |
355 | attachment. (See the next section for how to configure and use git to |
356 | send these emails for you.) | |
c2cf2042 | 357 | |
b1fccde5 LB |
358 | If you want to delete your temporary branch, you may do so with: |
359 | ||
360 | % git checkout blead | |
361 | % git branch -d orange | |
362 | error: The branch 'orange' is not an ancestor of your current HEAD. | |
363 | If you are sure you want to delete it, run 'git branch -D orange'. | |
364 | % git branch -D orange | |
365 | Deleted branch orange. | |
7df2e4bc | 366 | |
2d5f1d01 DG |
367 | =head2 Using git to send patch emails |
368 | ||
333f8875 VP |
369 | In your ~/git/perl repository, set the destination email to the |
370 | perl5-porters mailing list. | |
2d5f1d01 DG |
371 | |
372 | $ git config sendemail.to perl5-porters@perl.org | |
373 | ||
374 | Then you can use git directly to send your patch emails: | |
375 | ||
376 | $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch | |
377 | ||
333f8875 VP |
378 | You may need to set some configuration variables for your particular |
379 | email service provider. For example, to set your global git config to | |
380 | send email via a gmail account: | |
2d5f1d01 DG |
381 | |
382 | $ git config --global sendemail.smtpserver smtp.gmail.com | |
383 | $ git config --global sendemail.smtpssl 1 | |
384 | $ git config --global sendemail.smtpuser YOURUSERNAME@gmail.com | |
385 | ||
333f8875 VP |
386 | With this configuration, you will be prompted for your gmail password |
387 | when you run 'git send-email'. You can also configure | |
388 | C<sendemail.smtppass> with your password if you don't care about having | |
389 | your password in the .gitconfig file. | |
2d5f1d01 | 390 | |
a44f43ac RGS |
391 | =head2 A note on derived files |
392 | ||
393 | Be aware that many files in the distribution are derivative--avoid | |
0549aefb LB |
394 | patching them, because git won't see the changes to them, and the build |
395 | process will overwrite them. Patch the originals instead. Most | |
396 | utilities (like perldoc) are in this category, i.e. patch | |
397 | utils/perldoc.PL rather than utils/perldoc. Similarly, don't create | |
398 | patches for files under $src_root/ext from their copies found in | |
399 | $install_root/lib. If you are unsure about the proper location of a | |
400 | file that may have gotten copied while building the source | |
401 | distribution, consult the C<MANIFEST>. | |
a44f43ac | 402 | |
ac1cbfb0 JC |
403 | As a special case, several files are regenerated by 'make regen' if |
404 | your patch alters C<embed.fnc>. These are needed for compilation, but | |
405 | are included in the distribution so that you can build perl without | |
406 | needing another perl to generate the files. You must test with these | |
407 | regenerated files, but it is preferred that you instead note that | |
408 | 'make regen is needed' in both the email and the commit message, and | |
409 | submit your patch without them. If you're submitting a series of | |
410 | patches, it might be best to submit the regenerated changes | |
411 | immediately after the source-changes that caused them, so as to have | |
412 | as little effect as possible on the bisectability of your patchset. | |
413 | ||
6e2cec71 | 414 | =for XXX |
a44f43ac | 415 | |
6e2cec71 | 416 | What should we recommend about binary files now? Do we need anything? |
a44f43ac RGS |
417 | |
418 | =head2 Getting your patch accepted | |
419 | ||
bdaf0bc6 | 420 | If you are submitting a code patch there are several things that |
a44f43ac RGS |
421 | you need to do. |
422 | ||
423 | =over 4 | |
424 | ||
bdaf0bc6 JV |
425 | =item Commit message |
426 | ||
427 | As you craft each patch you intend to submit to the Perl core, it's | |
428 | important to write a good commit message. | |
429 | ||
430 | Your commit message should start with a description of the problem that | |
431 | the patch corrects or new functionality that the patch adds. | |
432 | ||
bdaf0bc6 JV |
433 | As a general rule of thumb, your commit message should let a programmer |
434 | with a reasonable familiarity with the Perl core quickly understand what | |
435 | you were trying to do, how you were trying to do it and why the change | |
436 | matters to Perl. | |
437 | ||
438 | =over 4 | |
439 | ||
440 | =item What | |
441 | ||
ac1cbfb0 JC |
442 | Your commit message should describe what part of the Perl core you're |
443 | changing and what you expect your patch to do. | |
bdaf0bc6 JV |
444 | |
445 | =item Why | |
446 | ||
447 | Perhaps most importantly, your commit message should describe why the | |
448 | change you are making is important. When someone looks at your change | |
449 | in six months or six years, your intent should be clear. If you're | |
450 | deprecating a feature with the intent of later simplifying another bit | |
451 | of code, say so. If you're fixing a performance problem or adding a new | |
452 | feature to support some other bit of the core, mention that. | |
453 | ||
454 | =item How | |
455 | ||
456 | While it's not necessary for documentation changes, new tests or | |
457 | trivial patches, it's often worth explaining how your change works. | |
458 | Even if it's clear to you today, it may not be clear to a porter next | |
459 | month or next year. | |
460 | ||
461 | =back | |
462 | ||
ea9c0d74 JV |
463 | A commit message isn't intended to take the place of comments in your |
464 | code. Commit messages should describe the change you made, while code | |
80a0006a JV |
465 | comments should describe the current state of the code. If you've just |
466 | implemented a new feature, complete with doc, tests and well-commented | |
467 | code, a brief commit message will often suffice. If, however, you've | |
468 | just changed a single character deep in the parser or lexer, you might | |
ea9c0d74 JV |
469 | need to write a small novel to ensure that future readers understand |
470 | what you did and why you did it. | |
471 | ||
a44f43ac RGS |
472 | =item Comments, Comments, Comments |
473 | ||
0549aefb LB |
474 | Be sure to adequately comment your code. While commenting every line |
475 | is unnecessary, anything that takes advantage of side effects of | |
a44f43ac | 476 | operators, that creates changes that will be felt outside of the |
0549aefb LB |
477 | function being patched, or that others may find confusing should be |
478 | documented. If you are going to err, it is better to err on the side | |
479 | of adding too many comments than too few. | |
a44f43ac RGS |
480 | |
481 | =item Style | |
482 | ||
0549aefb LB |
483 | In general, please follow the particular style of the code you are |
484 | patching. | |
a44f43ac | 485 | |
0549aefb LB |
486 | In particular, follow these general guidelines for patching Perl |
487 | sources: | |
a44f43ac RGS |
488 | |
489 | 8-wide tabs (no exceptions!) | |
490 | 4-wide indents for code, 2-wide indents for nested CPP #defines | |
491 | try hard not to exceed 79-columns | |
492 | ANSI C prototypes | |
493 | uncuddled elses and "K&R" style for indenting control constructs | |
494 | no C++ style (//) comments | |
495 | mark places that need to be revisited with XXX (and revisit often!) | |
496 | opening brace lines up with "if" when conditional spans multiple | |
497 | lines; should be at end-of-line otherwise | |
498 | in function definitions, name starts in column 0 (return value is on | |
499 | previous line) | |
500 | single space after keywords that are followed by parens, no space | |
501 | between function name and following paren | |
502 | avoid assignments in conditionals, but if they're unavoidable, use | |
503 | extra paren, e.g. "if (a && (b = c)) ..." | |
504 | "return foo;" rather than "return(foo);" | |
505 | "if (!foo) ..." rather than "if (foo == FALSE) ..." etc. | |
506 | ||
507 | =item Testsuite | |
508 | ||
bdaf0bc6 JV |
509 | If your patch changes code (rather than just changing documentation) you |
510 | should also include one or more test cases which illustrate the bug you're | |
511 | fixing or validate the new functionality you're adding. In general, | |
512 | you should update an existing test file rather than create a new one. | |
513 | ||
0549aefb LB |
514 | Your testsuite additions should generally follow these guidelines |
515 | (courtesy of Gurusamy Sarathy <gsar@activestate.com>): | |
a44f43ac RGS |
516 | |
517 | Know what you're testing. Read the docs, and the source. | |
518 | Tend to fail, not succeed. | |
519 | Interpret results strictly. | |
520 | Use unrelated features (this will flush out bizarre interactions). | |
521 | Use non-standard idioms (otherwise you are not testing TIMTOWTDI). | |
522 | Avoid using hardcoded test numbers whenever possible (the | |
523 | EXPECTED/GOT found in t/op/tie.t is much more maintainable, | |
524 | and gives better failure reports). | |
525 | Give meaningful error messages when a test fails. | |
526 | Avoid using qx// and system() unless you are testing for them. If you | |
527 | do use them, make sure that you cover _all_ perl platforms. | |
528 | Unlink any temporary files you create. | |
529 | Promote unforeseen warnings to errors with $SIG{__WARN__}. | |
530 | Be sure to use the libraries and modules shipped with the version | |
531 | being tested, not those that were already installed. | |
532 | Add comments to the code explaining what you are testing for. | |
533 | Make updating the '1..42' string unnecessary. Or make sure that | |
534 | you update it. | |
535 | Test _all_ behaviors of a given operator, library, or function: | |
536 | - All optional arguments | |
537 | - Return values in various contexts (boolean, scalar, list, lvalue) | |
538 | - Use both global and lexical variables | |
539 | - Don't forget the exceptional, pathological cases. | |
540 | ||
541 | =back | |
542 | ||
7df2e4bc LB |
543 | =head1 ACCEPTING A PATCH |
544 | ||
545 | If you have received a patch file generated using the above section, | |
546 | you should try out the patch. | |
547 | ||
548 | First we need to create a temporary new branch for these changes and | |
549 | switch into it: | |
550 | ||
a9b05323 | 551 | % git checkout -b experimental |
7df2e4bc | 552 | |
6acba58e LB |
553 | Patches that were formatted by C<git format-patch> are applied with |
554 | C<git am>: | |
7df2e4bc | 555 | |
2af192ee | 556 | % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch |
7df2e4bc LB |
557 | Applying Rename Leon Brocard to Orange Brocard |
558 | ||
6acba58e LB |
559 | If just a raw diff is provided, it is also possible use this two-step |
560 | process: | |
09645c26 VP |
561 | |
562 | % git apply bugfix.diff | |
dc3c3040 | 563 | % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>" |
09645c26 | 564 | |
7df2e4bc LB |
565 | Now we can inspect the change: |
566 | ||
dc3c3040 | 567 | % git show HEAD |
7df2e4bc LB |
568 | commit b1b3dab48344cff6de4087efca3dbd63548ab5e2 |
569 | Author: Leon Brocard <acme@astray.com> | |
570 | Date: Fri Dec 19 17:02:59 2008 +0000 | |
571 | ||
572 | Rename Leon Brocard to Orange Brocard | |
7df2e4bc | 573 | |
7df2e4bc LB |
574 | diff --git a/AUTHORS b/AUTHORS |
575 | index 293dd70..722c93e 100644 | |
576 | --- a/AUTHORS | |
577 | +++ b/AUTHORS | |
578 | @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie> | |
579 | Laszlo Molnar <laszlo.molnar@eth.ericsson.se> | |
580 | Leif Huhn <leif@hale.dkstat.com> | |
581 | Len Johnson <lenjay@ibm.net> | |
582 | -Leon Brocard <acme@astray.com> | |
583 | +Orange Brocard <acme@astray.com> | |
584 | Les Peters <lpeters@aol.net> | |
585 | Lesley Binks <lesley.binks@gmail.com> | |
586 | Lincoln D. Stein <lstein@cshl.org> | |
587 | ||
588 | If you are a committer to Perl and you think the patch is good, you can | |
75fb7651 | 589 | then merge it into blead then push it out to the main repository: |
7df2e4bc LB |
590 | |
591 | % git checkout blead | |
d9847473 | 592 | % git merge experimental |
75fb7651 | 593 | % git push |
7df2e4bc LB |
594 | |
595 | If you want to delete your temporary branch, you may do so with: | |
596 | ||
597 | % git checkout blead | |
598 | % git branch -d experimental | |
599 | error: The branch 'experimental' is not an ancestor of your current HEAD. | |
600 | If you are sure you want to delete it, run 'git branch -D experimental'. | |
601 | % git branch -D experimental | |
602 | Deleted branch experimental. | |
b0d36535 YO |
603 | |
604 | =head1 CLEANING A WORKING DIRECTORY | |
605 | ||
6acba58e | 606 | The command C<git clean> can with varying arguments be used as a |
dc3c3040 | 607 | replacement for C<make clean>. |
b0d36535 YO |
608 | |
609 | To reset your working directory to a pristine condition you can do: | |
610 | ||
611 | git clean -dxf | |
612 | ||
613 | However, be aware this will delete ALL untracked content. You can use | |
614 | ||
615 | git clean -Xf | |
616 | ||
6acba58e LB |
617 | to remove all ignored untracked files, such as build and test |
618 | byproduct, but leave any manually created files alone. | |
b0d36535 | 619 | |
0549aefb | 620 | If you only want to cancel some uncommitted edits, you can use C<git |
c26da522 LB |
621 | checkout> and give it a list of files to be reverted, or C<git checkout |
622 | -f> to revert them all. | |
f755e97d RGS |
623 | |
624 | If you want to cancel one or several commits, you can use C<git reset>. | |
625 | ||
d82a90c1 VP |
626 | =head1 BISECTING |
627 | ||
6acba58e LB |
628 | C<git> provides a built-in way to determine, with a binary search in |
629 | the history, which commit should be blamed for introducing a given bug. | |
d82a90c1 | 630 | |
6acba58e | 631 | Suppose that we have a script F<~/testcase.pl> that exits with C<0> |
bdaf0bc6 | 632 | when some behaviour is correct, and with C<1> when it's faulty. You need |
6acba58e LB |
633 | an helper script that automates building C<perl> and running the |
634 | testcase: | |
d82a90c1 VP |
635 | |
636 | % cat ~/run | |
637 | #!/bin/sh | |
638 | git clean -dxf | |
639 | # If you can use ccache, add -Dcc=ccache\ gcc -Dld=gcc to the Configure line | |
1d5fe431 MB |
640 | # if Encode is not needed for the test, you can speed up the bisect by |
641 | # excluding it from the runs with -Dnoextensions=Encode | |
c0d1ef72 MB |
642 | sh Configure -des -Dusedevel -Doptimize="-g" |
643 | test -f config.sh || exit 125 | |
644 | # Correct makefile for newer GNU gcc | |
645 | perl -ni -we 'print unless /<(?:built-in|command)/' makefile x2p/makefile | |
646 | # if you just need miniperl, replace test_prep with miniperl | |
647 | make -j4 test_prep | |
68814ba4 | 648 | [ -x ./perl ] || exit 125 |
d82a90c1 | 649 | ./perl -Ilib ~/testcase.pl |
c0d1ef72 | 650 | ret=$? |
7930c68b | 651 | [ $ret -gt 127 ] && ret=127 |
c0d1ef72 MB |
652 | git clean -dxf |
653 | exit $ret | |
d82a90c1 | 654 | |
6acba58e LB |
655 | This script may return C<125> to indicate that the corresponding commit |
656 | should be skipped. Otherwise, it returns the status of | |
657 | F<~/testcase.pl>. | |
d82a90c1 | 658 | |
bdaf0bc6 | 659 | You first enter in bisect mode with: |
d82a90c1 VP |
660 | |
661 | % git bisect start | |
662 | ||
6acba58e LB |
663 | For example, if the bug is present on C<HEAD> but wasn't in 5.10.0, |
664 | C<git> will learn about this when you enter: | |
d82a90c1 VP |
665 | |
666 | % git bisect bad | |
667 | % git bisect good perl-5.10.0 | |
668 | Bisecting: 853 revisions left to test after this | |
669 | ||
6acba58e | 670 | This results in checking out the median commit between C<HEAD> and |
bdaf0bc6 | 671 | C<perl-5.10.0>. You can then run the bisecting process with: |
d82a90c1 VP |
672 | |
673 | % git bisect run ~/run | |
674 | ||
675 | When the first bad commit is isolated, C<git bisect> will tell you so: | |
676 | ||
677 | ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit | |
678 | commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 | |
679 | Author: Dave Mitchell <davem@fdisolutions.com> | |
680 | Date: Sat Feb 9 14:56:23 2008 +0000 | |
681 | ||
9469eb4a | 682 | [perl #49472] Attributes + Unknown Error |
d82a90c1 VP |
683 | ... |
684 | ||
685 | bisect run success | |
686 | ||
6acba58e LB |
687 | You can peek into the bisecting process with C<git bisect log> and |
688 | C<git bisect visualize>. C<git bisect reset> will get you out of bisect | |
689 | mode. | |
d82a90c1 | 690 | |
6acba58e LB |
691 | Please note that the first C<good> state must be an ancestor of the |
692 | first C<bad> state. If you want to search for the commit that I<solved> | |
693 | some bug, you have to negate your test case (i.e. exit with C<1> if OK | |
694 | and C<0> if not) and still mark the lower bound as C<good> and the | |
695 | upper as C<bad>. The "first bad commit" has then to be understood as | |
696 | the "first commit where the bug is solved". | |
d82a90c1 | 697 | |
6acba58e LB |
698 | C<git help bisect> has much more information on how you can tweak your |
699 | binary searches. | |
9d68b7ed | 700 | |
03050721 LB |
701 | =head1 SUBMITTING A PATCH VIA GITHUB |
702 | ||
703 | GitHub is a website that makes it easy to fork and publish projects | |
704 | with Git. First you should set up a GitHub account and log in. | |
705 | ||
706 | Perl's git repository is mirrored on GitHub at this page: | |
707 | ||
708 | http://github.com/github/perl/tree/blead | |
709 | ||
710 | Visit the page and click the "fork" button. This clones the Perl git | |
711 | repository for you and provides you with "Your Clone URL" from which | |
712 | you should clone: | |
713 | ||
714 | % git clone git@github.com:USERNAME/perl.git perl-github | |
715 | ||
bdaf0bc6 | 716 | The same patch as above, using github might look like this: |
03050721 LB |
717 | |
718 | % cd perl-github | |
719 | % git remote add upstream git://github.com/github/perl.git | |
720 | % git pull upstream blead | |
721 | % git checkout -b orange | |
722 | % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS | |
dc3c3040 | 723 | % git commit -a -m 'Rename Leon Brocard to Orange Brocard' |
03050721 LB |
724 | % git push origin orange |
725 | ||
726 | The orange branch has been pushed to GitHub, so you should now send an | |
727 | email to perl5-porters@perl.org with a description of your changes and | |
728 | the following information: | |
729 | ||
730 | http://github.com/USERNAME/perl/tree/orange | |
731 | git@github.com:USERNAME/perl.git branch orange | |
732 | ||
c26da522 LB |
733 | =head1 MERGING FROM A BRANCH VIA GITHUB |
734 | ||
735 | If someone has provided a branch via GitHub and you are a committer, | |
5c9c28c6 | 736 | you should use the following in your perl-ssh directory: |
c26da522 LB |
737 | |
738 | % git remote add dandv git://github.com/dandv/perl.git | |
739 | % git fetch | |
740 | ||
741 | Now you can see the differences between the branch and blead: | |
742 | ||
743 | % git diff dandv/blead | |
744 | ||
745 | And you can see the commits: | |
746 | ||
747 | % git log dandv/blead | |
748 | ||
749 | If you approve of a specific commit, you can cherry pick it: | |
750 | ||
2bab0636 LB |
751 | % git cherry-pick 3adac458cb1c1d41af47fc66e67b49c8dec2323f |
752 | ||
753 | Or you could just merge the whole branch if you like it all: | |
754 | ||
755 | % git merge dandv/blead | |
c26da522 LB |
756 | |
757 | And then push back to the repository: | |
758 | ||
759 | % git push | |
760 | ||
ce2a8773 JV |
761 | |
762 | =head1 TOPIC BRANCHES AND REWRITING HISTORY | |
763 | ||
764 | Individual committers should create topic branches under | |
333f8875 VP |
765 | B<yourname>/B<some_descriptive_name>. Other committers should check |
766 | with a topic branch's creator before making any change to it. | |
ce2a8773 JV |
767 | |
768 | If you are not the creator of B<yourname>/B<some_descriptive_name>, you | |
769 | might sometimes find that the original author has edited the branch's | |
770 | history. There are lots of good reasons for this. Sometimes, an author | |
333f8875 VP |
771 | might simply be rebasing the branch onto a newer source point. |
772 | Sometimes, an author might have found an error in an early commit which | |
773 | they wanted to fix before merging the branch to blead. | |
ce2a8773 | 774 | |
333f8875 VP |
775 | Currently the master repository is configured to forbid |
776 | non-fast-forward merges. This means that the branches within can not | |
777 | be rebased and pushed as a single step. | |
ce2a8773 | 778 | |
333f8875 VP |
779 | The only way you will ever be allowed to rebase or modify the history |
780 | of a pushed branch is to delete it and push it as a new branch under | |
781 | the same name. Please think carefully about doing this. It may be | |
782 | better to sequentially rename your branches so that it is easier for | |
783 | others working with you to cherry-pick their local changes onto the new | |
784 | version. (XXX: needs explanation). | |
ce2a8773 JV |
785 | |
786 | If you want to rebase a personal topic branch, you will have to delete | |
2699d634 YO |
787 | your existing topic branch and push as a new version of it. You can do |
788 | this via the following formula (see the explanation about C<refspec>'s | |
789 | in the git push documentation for details) after you have rebased your | |
790 | branch: | |
791 | ||
792 | # first rebase | |
793 | $ git checkout $user/$topic | |
794 | $ git fetch | |
795 | $ git rebase origin/blead | |
796 | ||
797 | # then "delete-and-push" | |
798 | $ git push origin :$user/$topic | |
799 | $ git push origin $user/$topic | |
800 | ||
801 | B<NOTE:> it is forbidden at the repository level to delete any of the | |
333f8875 VP |
802 | "primary" branches. That is any branch matching |
803 | C<m!^(blead|maint|perl)!>. Any attempt to do so will result in git | |
804 | producing an error like this: | |
2699d634 YO |
805 | |
806 | $ git push origin :blead | |
807 | *** It is forbidden to delete blead/maint branches in this repository | |
808 | error: hooks/update exited with error code 1 | |
809 | error: hook declined to update refs/heads/blead | |
333f8875 | 810 | To ssh://perl5.git.perl.org/perl |
2699d634 | 811 | ! [remote rejected] blead (hook declined) |
333f8875 | 812 | error: failed to push some refs to 'ssh://perl5.git.perl.org/perl' |
2699d634 | 813 | |
333f8875 VP |
814 | As a matter of policy we do B<not> edit the history of the blead and |
815 | maint-* branches. If a typo (or worse) sneaks into a commit to blead or | |
816 | maint-*, we'll fix it in another commit. The only types of updates | |
817 | allowed on these branches are "fast-forward's", where all history is | |
818 | preserved. | |
2699d634 | 819 | |
333f8875 VP |
820 | Annotated tags in the canonical perl.git repository will never be |
821 | deleted or modified. Think long and hard about whether you want to push | |
822 | a local tag to perl.git before doing so. (Pushing unannotated tags is | |
2699d634 | 823 | not allowed.) |
ce2a8773 | 824 | |
9469eb4a | 825 | =head1 COMMITTING TO MAINTENANCE VERSIONS |
9d68b7ed | 826 | |
7f4ffa9d RS |
827 | Maintenance versions should only be altered to add critical bug fixes. |
828 | ||
9d68b7ed LB |
829 | To commit to a maintenance version of perl, you need to create a local |
830 | tracking branch: | |
831 | ||
832 | % git checkout --track -b maint-5.005 origin/maint-5.005 | |
833 | ||
0549aefb LB |
834 | This creates a local branch named C<maint-5.005>, which tracks the |
835 | remote branch C<origin/maint-5.005>. Then you can pull, commit, merge | |
836 | and push as before. | |
b0d36535 | 837 | |
f755e97d | 838 | You can also cherry-pick commits from blead and another branch, by |
0549aefb LB |
839 | using the C<git cherry-pick> command. It is recommended to use the |
840 | B<-x> option to C<git cherry-pick> in order to record the SHA1 of the | |
841 | original commit in the new commit message. | |
f755e97d | 842 | |
e8589bfa AV |
843 | =head1 GRAFTS |
844 | ||
845 | The perl history contains one mistake which was not caught in the | |
ac036724 | 846 | conversion: a merge was recorded in the history between blead and |
333f8875 VP |
847 | maint-5.10 where no merge actually occurred. Due to the nature of git, |
848 | this is now impossible to fix in the public repository. You can remove | |
849 | this mis-merge locally by adding the following line to your | |
e8589bfa AV |
850 | C<.git/info/grafts> file: |
851 | ||
852 | 296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930 | |
853 | ||
854 | It is particularly important to have this graft line if any bisecting | |
855 | is done in the area of the "merge" in question. | |
856 | ||
bdaf0bc6 JV |
857 | |
858 | ||
f755e97d RGS |
859 | =head1 SEE ALSO |
860 | ||
861 | The git documentation, accessible via C<git help command>. | |
0549aefb | 862 |