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 YO |
229 | |
230 | Assuming we commit all the mentioned changes above: | |
231 | ||
232 | % git commit -a -m'explain git status and stuff about remotes' | |
233 | Created commit daf8e63: explain git status and stuff about remotes | |
234 | 1 files changed, 83 insertions(+), 3 deletions(-) | |
235 | ||
236 | We can re-run git status and see something like this: | |
237 | ||
238 | % git status | |
239 | # On branch blead | |
240 | # Your branch is ahead of 'origin/blead' by 2 commits. | |
241 | # | |
242 | # Untracked files: | |
243 | # (use "git add <file>..." to include in what will be committed) | |
244 | # | |
245 | # deliberate.untracked | |
246 | nothing added to commit but untracked files present (use "git add" to track) | |
247 | ||
39219fd3 | 248 | |
6acba58e LB |
249 | When in doubt, before you do anything else, check your status and read |
250 | it carefully, many questions are answered directly by the git status | |
251 | output. | |
39219fd3 | 252 | |
c2cf2042 LB |
253 | =head1 SUBMITTING A PATCH |
254 | ||
255 | If you have a patch in mind for Perl, you should first get a copy of | |
256 | the repository: | |
257 | ||
258 | % git clone git://perl5.git.perl.org/perl.git perl-git | |
259 | ||
260 | Then change into the directory: | |
261 | ||
262 | % cd perl-git | |
263 | ||
6acba58e LB |
264 | Alternatively, if you already have a Perl repository, you should ensure |
265 | that you're on the I<blead> branch, and your repository is up to date: | |
12322d22 A |
266 | |
267 | % git checkout blead | |
268 | % git pull | |
269 | ||
6a7cbfe8 LB |
270 | It's preferable to patch against the latest blead version, since this |
271 | is where new development occurs for all changes other than critical bug | |
272 | fixes. Critical bug fix patches should be made against the relevant | |
7f4ffa9d RS |
273 | maint branches, or should be submitted with a note indicating all the |
274 | branches where the fix should be applied. | |
a44f43ac | 275 | |
6acba58e LB |
276 | Now that we have everything up to date, we need to create a temporary |
277 | new branch for these changes and switch into it: | |
b1fccde5 | 278 | |
a9b05323 | 279 | % git checkout -b orange |
23f8d33e | 280 | |
a9b05323 YO |
281 | which is the short form of |
282 | ||
b1fccde5 LB |
283 | % git branch orange |
284 | % git checkout orange | |
285 | ||
c2cf2042 LB |
286 | Then make your changes. For example, if Leon Brocard changes his name |
287 | to Orange Brocard, we should change his name in the AUTHORS file: | |
288 | ||
289 | % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS | |
290 | ||
291 | You can see what files are changed: | |
292 | ||
293 | % git status | |
f755e97d | 294 | # On branch orange |
c2cf2042 LB |
295 | # Changes to be committed: |
296 | # (use "git reset HEAD <file>..." to unstage) | |
297 | # | |
2699d634 | 298 | # modified: AUTHORS |
c2cf2042 LB |
299 | # |
300 | ||
c2cf2042 LB |
301 | And you can see the changes: |
302 | ||
303 | % git diff | |
304 | diff --git a/AUTHORS b/AUTHORS | |
305 | index 293dd70..722c93e 100644 | |
306 | --- a/AUTHORS | |
307 | +++ b/AUTHORS | |
7df2e4bc | 308 | @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie> |
c2cf2042 LB |
309 | Laszlo Molnar <laszlo.molnar@eth.ericsson.se> |
310 | Leif Huhn <leif@hale.dkstat.com> | |
311 | Len Johnson <lenjay@ibm.net> | |
312 | -Leon Brocard <acme@astray.com> | |
313 | +Orange Brocard <acme@astray.com> | |
314 | Les Peters <lpeters@aol.net> | |
315 | Lesley Binks <lesley.binks@gmail.com> | |
316 | Lincoln D. Stein <lstein@cshl.org> | |
317 | ||
318 | Now commit your change locally: | |
319 | ||
dc3c3040 | 320 | % git commit -a -m 'Rename Leon Brocard to Orange Brocard' |
c2cf2042 LB |
321 | Created commit 6196c1d: Rename Leon Brocard to Orange Brocard |
322 | 1 files changed, 1 insertions(+), 1 deletions(-) | |
323 | ||
dc3c3040 GA |
324 | You can examine your last commit with: |
325 | ||
326 | % git show HEAD | |
327 | ||
328 | and if you are not happy with either the description or the patch | |
c26da522 | 329 | itself you can fix it up by editing the files once more and then issue: |
dc3c3040 GA |
330 | |
331 | % git commit -a --amend | |
332 | ||
c2cf2042 LB |
333 | Now you should create a patch file for all your local changes: |
334 | ||
2af192ee | 335 | % git format-patch origin |
c2cf2042 LB |
336 | 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch |
337 | ||
338 | You should now send an email to perl5-porters@perl.org with a | |
dc3c3040 | 339 | description of your changes, and include this patch file as an |
333f8875 VP |
340 | attachment. (See the next section for how to configure and use git to |
341 | send these emails for you.) | |
c2cf2042 | 342 | |
b1fccde5 LB |
343 | If you want to delete your temporary branch, you may do so with: |
344 | ||
345 | % git checkout blead | |
346 | % git branch -d orange | |
347 | error: The branch 'orange' is not an ancestor of your current HEAD. | |
348 | If you are sure you want to delete it, run 'git branch -D orange'. | |
349 | % git branch -D orange | |
350 | Deleted branch orange. | |
7df2e4bc | 351 | |
2d5f1d01 DG |
352 | =head2 Using git to send patch emails |
353 | ||
333f8875 VP |
354 | In your ~/git/perl repository, set the destination email to the |
355 | perl5-porters mailing list. | |
2d5f1d01 DG |
356 | |
357 | $ git config sendemail.to perl5-porters@perl.org | |
358 | ||
359 | Then you can use git directly to send your patch emails: | |
360 | ||
361 | $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch | |
362 | ||
333f8875 VP |
363 | You may need to set some configuration variables for your particular |
364 | email service provider. For example, to set your global git config to | |
365 | send email via a gmail account: | |
2d5f1d01 DG |
366 | |
367 | $ git config --global sendemail.smtpserver smtp.gmail.com | |
368 | $ git config --global sendemail.smtpssl 1 | |
369 | $ git config --global sendemail.smtpuser YOURUSERNAME@gmail.com | |
370 | ||
333f8875 VP |
371 | With this configuration, you will be prompted for your gmail password |
372 | when you run 'git send-email'. You can also configure | |
373 | C<sendemail.smtppass> with your password if you don't care about having | |
374 | your password in the .gitconfig file. | |
2d5f1d01 | 375 | |
a44f43ac RGS |
376 | =head2 A note on derived files |
377 | ||
378 | Be aware that many files in the distribution are derivative--avoid | |
0549aefb LB |
379 | patching them, because git won't see the changes to them, and the build |
380 | process will overwrite them. Patch the originals instead. Most | |
381 | utilities (like perldoc) are in this category, i.e. patch | |
382 | utils/perldoc.PL rather than utils/perldoc. Similarly, don't create | |
383 | patches for files under $src_root/ext from their copies found in | |
384 | $install_root/lib. If you are unsure about the proper location of a | |
385 | file that may have gotten copied while building the source | |
386 | distribution, consult the C<MANIFEST>. | |
a44f43ac | 387 | |
6e2cec71 | 388 | =for XXX |
a44f43ac | 389 | |
6e2cec71 | 390 | What should we recommend about binary files now? Do we need anything? |
a44f43ac RGS |
391 | |
392 | =head2 Getting your patch accepted | |
393 | ||
0549aefb LB |
394 | The first thing you should include with your patch is a description of |
395 | the problem that the patch corrects. If it is a code patch (rather | |
396 | than a documentation patch) you should also include a small test case | |
397 | that illustrates the bug (a patch to an existing test file is | |
398 | preferred). | |
a44f43ac RGS |
399 | |
400 | If you are submitting a code patch there are several other things that | |
401 | you need to do. | |
402 | ||
403 | =over 4 | |
404 | ||
405 | =item Comments, Comments, Comments | |
406 | ||
0549aefb LB |
407 | Be sure to adequately comment your code. While commenting every line |
408 | is unnecessary, anything that takes advantage of side effects of | |
a44f43ac | 409 | operators, that creates changes that will be felt outside of the |
0549aefb LB |
410 | function being patched, or that others may find confusing should be |
411 | documented. If you are going to err, it is better to err on the side | |
412 | of adding too many comments than too few. | |
a44f43ac RGS |
413 | |
414 | =item Style | |
415 | ||
0549aefb LB |
416 | In general, please follow the particular style of the code you are |
417 | patching. | |
a44f43ac | 418 | |
0549aefb LB |
419 | In particular, follow these general guidelines for patching Perl |
420 | sources: | |
a44f43ac RGS |
421 | |
422 | 8-wide tabs (no exceptions!) | |
423 | 4-wide indents for code, 2-wide indents for nested CPP #defines | |
424 | try hard not to exceed 79-columns | |
425 | ANSI C prototypes | |
426 | uncuddled elses and "K&R" style for indenting control constructs | |
427 | no C++ style (//) comments | |
428 | mark places that need to be revisited with XXX (and revisit often!) | |
429 | opening brace lines up with "if" when conditional spans multiple | |
430 | lines; should be at end-of-line otherwise | |
431 | in function definitions, name starts in column 0 (return value is on | |
432 | previous line) | |
433 | single space after keywords that are followed by parens, no space | |
434 | between function name and following paren | |
435 | avoid assignments in conditionals, but if they're unavoidable, use | |
436 | extra paren, e.g. "if (a && (b = c)) ..." | |
437 | "return foo;" rather than "return(foo);" | |
438 | "if (!foo) ..." rather than "if (foo == FALSE) ..." etc. | |
439 | ||
440 | =item Testsuite | |
441 | ||
0549aefb | 442 | When submitting a patch you should make every effort to also include an |
2699d634 | 443 | addition to perl's regression tests to properly exercise your patch. |
0549aefb LB |
444 | Your testsuite additions should generally follow these guidelines |
445 | (courtesy of Gurusamy Sarathy <gsar@activestate.com>): | |
a44f43ac RGS |
446 | |
447 | Know what you're testing. Read the docs, and the source. | |
448 | Tend to fail, not succeed. | |
449 | Interpret results strictly. | |
450 | Use unrelated features (this will flush out bizarre interactions). | |
451 | Use non-standard idioms (otherwise you are not testing TIMTOWTDI). | |
452 | Avoid using hardcoded test numbers whenever possible (the | |
453 | EXPECTED/GOT found in t/op/tie.t is much more maintainable, | |
454 | and gives better failure reports). | |
455 | Give meaningful error messages when a test fails. | |
456 | Avoid using qx// and system() unless you are testing for them. If you | |
457 | do use them, make sure that you cover _all_ perl platforms. | |
458 | Unlink any temporary files you create. | |
459 | Promote unforeseen warnings to errors with $SIG{__WARN__}. | |
460 | Be sure to use the libraries and modules shipped with the version | |
461 | being tested, not those that were already installed. | |
462 | Add comments to the code explaining what you are testing for. | |
463 | Make updating the '1..42' string unnecessary. Or make sure that | |
464 | you update it. | |
465 | Test _all_ behaviors of a given operator, library, or function: | |
466 | - All optional arguments | |
467 | - Return values in various contexts (boolean, scalar, list, lvalue) | |
468 | - Use both global and lexical variables | |
469 | - Don't forget the exceptional, pathological cases. | |
470 | ||
471 | =back | |
472 | ||
7df2e4bc LB |
473 | =head1 ACCEPTING A PATCH |
474 | ||
475 | If you have received a patch file generated using the above section, | |
476 | you should try out the patch. | |
477 | ||
478 | First we need to create a temporary new branch for these changes and | |
479 | switch into it: | |
480 | ||
a9b05323 | 481 | % git checkout -b experimental |
7df2e4bc | 482 | |
6acba58e LB |
483 | Patches that were formatted by C<git format-patch> are applied with |
484 | C<git am>: | |
7df2e4bc | 485 | |
2af192ee | 486 | % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch |
7df2e4bc LB |
487 | Applying Rename Leon Brocard to Orange Brocard |
488 | ||
6acba58e LB |
489 | If just a raw diff is provided, it is also possible use this two-step |
490 | process: | |
09645c26 VP |
491 | |
492 | % git apply bugfix.diff | |
dc3c3040 | 493 | % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>" |
09645c26 | 494 | |
7df2e4bc LB |
495 | Now we can inspect the change: |
496 | ||
dc3c3040 | 497 | % git show HEAD |
7df2e4bc LB |
498 | commit b1b3dab48344cff6de4087efca3dbd63548ab5e2 |
499 | Author: Leon Brocard <acme@astray.com> | |
500 | Date: Fri Dec 19 17:02:59 2008 +0000 | |
501 | ||
502 | Rename Leon Brocard to Orange Brocard | |
7df2e4bc | 503 | |
7df2e4bc LB |
504 | diff --git a/AUTHORS b/AUTHORS |
505 | index 293dd70..722c93e 100644 | |
506 | --- a/AUTHORS | |
507 | +++ b/AUTHORS | |
508 | @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie> | |
509 | Laszlo Molnar <laszlo.molnar@eth.ericsson.se> | |
510 | Leif Huhn <leif@hale.dkstat.com> | |
511 | Len Johnson <lenjay@ibm.net> | |
512 | -Leon Brocard <acme@astray.com> | |
513 | +Orange Brocard <acme@astray.com> | |
514 | Les Peters <lpeters@aol.net> | |
515 | Lesley Binks <lesley.binks@gmail.com> | |
516 | Lincoln D. Stein <lstein@cshl.org> | |
517 | ||
518 | If you are a committer to Perl and you think the patch is good, you can | |
75fb7651 | 519 | then merge it into blead then push it out to the main repository: |
7df2e4bc LB |
520 | |
521 | % git checkout blead | |
d9847473 | 522 | % git merge experimental |
75fb7651 | 523 | % git push |
7df2e4bc LB |
524 | |
525 | If you want to delete your temporary branch, you may do so with: | |
526 | ||
527 | % git checkout blead | |
528 | % git branch -d experimental | |
529 | error: The branch 'experimental' is not an ancestor of your current HEAD. | |
530 | If you are sure you want to delete it, run 'git branch -D experimental'. | |
531 | % git branch -D experimental | |
532 | Deleted branch experimental. | |
b0d36535 YO |
533 | |
534 | =head1 CLEANING A WORKING DIRECTORY | |
535 | ||
6acba58e | 536 | The command C<git clean> can with varying arguments be used as a |
dc3c3040 | 537 | replacement for C<make clean>. |
b0d36535 YO |
538 | |
539 | To reset your working directory to a pristine condition you can do: | |
540 | ||
541 | git clean -dxf | |
542 | ||
543 | However, be aware this will delete ALL untracked content. You can use | |
544 | ||
545 | git clean -Xf | |
546 | ||
6acba58e LB |
547 | to remove all ignored untracked files, such as build and test |
548 | byproduct, but leave any manually created files alone. | |
b0d36535 | 549 | |
0549aefb | 550 | If you only want to cancel some uncommitted edits, you can use C<git |
c26da522 LB |
551 | checkout> and give it a list of files to be reverted, or C<git checkout |
552 | -f> to revert them all. | |
f755e97d RGS |
553 | |
554 | If you want to cancel one or several commits, you can use C<git reset>. | |
555 | ||
d82a90c1 VP |
556 | =head1 BISECTING |
557 | ||
6acba58e LB |
558 | C<git> provides a built-in way to determine, with a binary search in |
559 | the history, which commit should be blamed for introducing a given bug. | |
d82a90c1 | 560 | |
6acba58e LB |
561 | Suppose that we have a script F<~/testcase.pl> that exits with C<0> |
562 | when some behaviour is correct, and with C<1> when it's faulty. We need | |
563 | an helper script that automates building C<perl> and running the | |
564 | testcase: | |
d82a90c1 VP |
565 | |
566 | % cat ~/run | |
567 | #!/bin/sh | |
568 | git clean -dxf | |
569 | # If you can use ccache, add -Dcc=ccache\ gcc -Dld=gcc to the Configure line | |
1d5fe431 MB |
570 | # if Encode is not needed for the test, you can speed up the bisect by |
571 | # excluding it from the runs with -Dnoextensions=Encode | |
c0d1ef72 MB |
572 | sh Configure -des -Dusedevel -Doptimize="-g" |
573 | test -f config.sh || exit 125 | |
574 | # Correct makefile for newer GNU gcc | |
575 | perl -ni -we 'print unless /<(?:built-in|command)/' makefile x2p/makefile | |
576 | # if you just need miniperl, replace test_prep with miniperl | |
577 | make -j4 test_prep | |
68814ba4 | 578 | [ -x ./perl ] || exit 125 |
d82a90c1 | 579 | ./perl -Ilib ~/testcase.pl |
c0d1ef72 | 580 | ret=$? |
7930c68b | 581 | [ $ret -gt 127 ] && ret=127 |
c0d1ef72 MB |
582 | git clean -dxf |
583 | exit $ret | |
d82a90c1 | 584 | |
6acba58e LB |
585 | This script may return C<125> to indicate that the corresponding commit |
586 | should be skipped. Otherwise, it returns the status of | |
587 | F<~/testcase.pl>. | |
d82a90c1 VP |
588 | |
589 | We first enter in bisect mode with: | |
590 | ||
591 | % git bisect start | |
592 | ||
6acba58e LB |
593 | For example, if the bug is present on C<HEAD> but wasn't in 5.10.0, |
594 | C<git> will learn about this when you enter: | |
d82a90c1 VP |
595 | |
596 | % git bisect bad | |
597 | % git bisect good perl-5.10.0 | |
598 | Bisecting: 853 revisions left to test after this | |
599 | ||
6acba58e LB |
600 | This results in checking out the median commit between C<HEAD> and |
601 | C<perl-5.10.0>. We can then run the bisecting process with: | |
d82a90c1 VP |
602 | |
603 | % git bisect run ~/run | |
604 | ||
605 | When the first bad commit is isolated, C<git bisect> will tell you so: | |
606 | ||
607 | ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit | |
608 | commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 | |
609 | Author: Dave Mitchell <davem@fdisolutions.com> | |
610 | Date: Sat Feb 9 14:56:23 2008 +0000 | |
611 | ||
9469eb4a | 612 | [perl #49472] Attributes + Unknown Error |
d82a90c1 VP |
613 | ... |
614 | ||
615 | bisect run success | |
616 | ||
6acba58e LB |
617 | You can peek into the bisecting process with C<git bisect log> and |
618 | C<git bisect visualize>. C<git bisect reset> will get you out of bisect | |
619 | mode. | |
d82a90c1 | 620 | |
6acba58e LB |
621 | Please note that the first C<good> state must be an ancestor of the |
622 | first C<bad> state. If you want to search for the commit that I<solved> | |
623 | some bug, you have to negate your test case (i.e. exit with C<1> if OK | |
624 | and C<0> if not) and still mark the lower bound as C<good> and the | |
625 | upper as C<bad>. The "first bad commit" has then to be understood as | |
626 | the "first commit where the bug is solved". | |
d82a90c1 | 627 | |
6acba58e LB |
628 | C<git help bisect> has much more information on how you can tweak your |
629 | binary searches. | |
9d68b7ed | 630 | |
03050721 LB |
631 | =head1 SUBMITTING A PATCH VIA GITHUB |
632 | ||
633 | GitHub is a website that makes it easy to fork and publish projects | |
634 | with Git. First you should set up a GitHub account and log in. | |
635 | ||
636 | Perl's git repository is mirrored on GitHub at this page: | |
637 | ||
638 | http://github.com/github/perl/tree/blead | |
639 | ||
640 | Visit the page and click the "fork" button. This clones the Perl git | |
641 | repository for you and provides you with "Your Clone URL" from which | |
642 | you should clone: | |
643 | ||
644 | % git clone git@github.com:USERNAME/perl.git perl-github | |
645 | ||
646 | We shall make the same patch as above, creating a new branch: | |
647 | ||
648 | % cd perl-github | |
649 | % git remote add upstream git://github.com/github/perl.git | |
650 | % git pull upstream blead | |
651 | % git checkout -b orange | |
652 | % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS | |
dc3c3040 | 653 | % git commit -a -m 'Rename Leon Brocard to Orange Brocard' |
03050721 LB |
654 | % git push origin orange |
655 | ||
656 | The orange branch has been pushed to GitHub, so you should now send an | |
657 | email to perl5-porters@perl.org with a description of your changes and | |
658 | the following information: | |
659 | ||
660 | http://github.com/USERNAME/perl/tree/orange | |
661 | git@github.com:USERNAME/perl.git branch orange | |
662 | ||
c26da522 LB |
663 | =head1 MERGING FROM A BRANCH VIA GITHUB |
664 | ||
665 | If someone has provided a branch via GitHub and you are a committer, | |
5c9c28c6 | 666 | you should use the following in your perl-ssh directory: |
c26da522 LB |
667 | |
668 | % git remote add dandv git://github.com/dandv/perl.git | |
669 | % git fetch | |
670 | ||
671 | Now you can see the differences between the branch and blead: | |
672 | ||
673 | % git diff dandv/blead | |
674 | ||
675 | And you can see the commits: | |
676 | ||
677 | % git log dandv/blead | |
678 | ||
679 | If you approve of a specific commit, you can cherry pick it: | |
680 | ||
2bab0636 LB |
681 | % git cherry-pick 3adac458cb1c1d41af47fc66e67b49c8dec2323f |
682 | ||
683 | Or you could just merge the whole branch if you like it all: | |
684 | ||
685 | % git merge dandv/blead | |
c26da522 LB |
686 | |
687 | And then push back to the repository: | |
688 | ||
689 | % git push | |
690 | ||
ce2a8773 JV |
691 | |
692 | =head1 TOPIC BRANCHES AND REWRITING HISTORY | |
693 | ||
694 | Individual committers should create topic branches under | |
333f8875 VP |
695 | B<yourname>/B<some_descriptive_name>. Other committers should check |
696 | with a topic branch's creator before making any change to it. | |
ce2a8773 JV |
697 | |
698 | If you are not the creator of B<yourname>/B<some_descriptive_name>, you | |
699 | might sometimes find that the original author has edited the branch's | |
700 | history. There are lots of good reasons for this. Sometimes, an author | |
333f8875 VP |
701 | might simply be rebasing the branch onto a newer source point. |
702 | Sometimes, an author might have found an error in an early commit which | |
703 | they wanted to fix before merging the branch to blead. | |
ce2a8773 | 704 | |
333f8875 VP |
705 | Currently the master repository is configured to forbid |
706 | non-fast-forward merges. This means that the branches within can not | |
707 | be rebased and pushed as a single step. | |
ce2a8773 | 708 | |
333f8875 VP |
709 | The only way you will ever be allowed to rebase or modify the history |
710 | of a pushed branch is to delete it and push it as a new branch under | |
711 | the same name. Please think carefully about doing this. It may be | |
712 | better to sequentially rename your branches so that it is easier for | |
713 | others working with you to cherry-pick their local changes onto the new | |
714 | version. (XXX: needs explanation). | |
ce2a8773 JV |
715 | |
716 | If you want to rebase a personal topic branch, you will have to delete | |
2699d634 YO |
717 | your existing topic branch and push as a new version of it. You can do |
718 | this via the following formula (see the explanation about C<refspec>'s | |
719 | in the git push documentation for details) after you have rebased your | |
720 | branch: | |
721 | ||
722 | # first rebase | |
723 | $ git checkout $user/$topic | |
724 | $ git fetch | |
725 | $ git rebase origin/blead | |
726 | ||
727 | # then "delete-and-push" | |
728 | $ git push origin :$user/$topic | |
729 | $ git push origin $user/$topic | |
730 | ||
731 | B<NOTE:> it is forbidden at the repository level to delete any of the | |
333f8875 VP |
732 | "primary" branches. That is any branch matching |
733 | C<m!^(blead|maint|perl)!>. Any attempt to do so will result in git | |
734 | producing an error like this: | |
2699d634 YO |
735 | |
736 | $ git push origin :blead | |
737 | *** It is forbidden to delete blead/maint branches in this repository | |
738 | error: hooks/update exited with error code 1 | |
739 | error: hook declined to update refs/heads/blead | |
333f8875 | 740 | To ssh://perl5.git.perl.org/perl |
2699d634 | 741 | ! [remote rejected] blead (hook declined) |
333f8875 | 742 | error: failed to push some refs to 'ssh://perl5.git.perl.org/perl' |
2699d634 | 743 | |
333f8875 VP |
744 | As a matter of policy we do B<not> edit the history of the blead and |
745 | maint-* branches. If a typo (or worse) sneaks into a commit to blead or | |
746 | maint-*, we'll fix it in another commit. The only types of updates | |
747 | allowed on these branches are "fast-forward's", where all history is | |
748 | preserved. | |
2699d634 | 749 | |
333f8875 VP |
750 | Annotated tags in the canonical perl.git repository will never be |
751 | deleted or modified. Think long and hard about whether you want to push | |
752 | a local tag to perl.git before doing so. (Pushing unannotated tags is | |
2699d634 | 753 | not allowed.) |
ce2a8773 | 754 | |
9469eb4a | 755 | =head1 COMMITTING TO MAINTENANCE VERSIONS |
9d68b7ed | 756 | |
7f4ffa9d RS |
757 | Maintenance versions should only be altered to add critical bug fixes. |
758 | ||
9d68b7ed LB |
759 | To commit to a maintenance version of perl, you need to create a local |
760 | tracking branch: | |
761 | ||
762 | % git checkout --track -b maint-5.005 origin/maint-5.005 | |
763 | ||
0549aefb LB |
764 | This creates a local branch named C<maint-5.005>, which tracks the |
765 | remote branch C<origin/maint-5.005>. Then you can pull, commit, merge | |
766 | and push as before. | |
b0d36535 | 767 | |
f755e97d | 768 | You can also cherry-pick commits from blead and another branch, by |
0549aefb LB |
769 | using the C<git cherry-pick> command. It is recommended to use the |
770 | B<-x> option to C<git cherry-pick> in order to record the SHA1 of the | |
771 | original commit in the new commit message. | |
f755e97d | 772 | |
e8589bfa AV |
773 | =head1 GRAFTS |
774 | ||
775 | The perl history contains one mistake which was not caught in the | |
776 | conversion -- a merge was recorded in the history between blead and | |
333f8875 VP |
777 | maint-5.10 where no merge actually occurred. Due to the nature of git, |
778 | this is now impossible to fix in the public repository. You can remove | |
779 | this mis-merge locally by adding the following line to your | |
e8589bfa AV |
780 | C<.git/info/grafts> file: |
781 | ||
782 | 296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930 | |
783 | ||
784 | It is particularly important to have this graft line if any bisecting | |
785 | is done in the area of the "merge" in question. | |
786 | ||
f755e97d RGS |
787 | =head1 SEE ALSO |
788 | ||
789 | The git documentation, accessible via C<git help command>. | |
0549aefb | 790 |