This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move the example git bisect shell script from perlgit.pod to Porting/
[perl5.git] / pod / perlgit.pod
1 =encoding utf8
2
3 =for comment
4 Consistent formatting of this file is achieved with:
5   perl ./Porting/podtidy pod/perlgit.pod
6
7 =head1 NAME
8
9 perlgit - Detailed information about git and the Perl repository
10
11 =head1 DESCRIPTION
12
13 This document provides details on using git to develop Perl. If you are
14 just interested in working on a quick patch, see L<perlhack> first.
15 This document is intended for people who are regular contributors to
16 Perl, including those with write access to the git repository.
17
18 =head1 CLONING THE REPOSITORY
19
20 All of Perl's source code is kept centrally in a Git repository at
21 I<perl5.git.perl.org>.
22
23 You can make a read-only clone of the repository by running:
24
25   % git clone git://perl5.git.perl.org/perl.git perl
26
27 This uses the git protocol (port 9418).
28
29 If you cannot use the git protocol for firewall reasons, you can also
30 clone via http, though this is much slower:
31
32   % git clone http://perl5.git.perl.org/perl.git perl
33
34 =head1 WORKING WITH THE REPOSITORY
35
36 Once you have changed into the repository directory, you can inspect
37 it. After a clone the repository will contain a single local branch,
38 which will be the current branch as well, as indicated by the asterisk.
39
40   % git branch
41   * blead
42
43 Using the -a switch to C<branch> will also show the remote tracking
44 branches in the repository:
45
46   % git branch -a
47   * blead
48     origin/HEAD
49     origin/blead
50   ...
51
52 The branches that begin with "origin" correspond to the "git remote"
53 that you cloned from (which is named "origin"). Each branch on the
54 remote will be exactly tracked by these branches. You should NEVER do
55 work on these remote tracking branches. You only ever do work in a
56 local branch. Local branches can be configured to automerge (on pull)
57 from a designated remote tracking branch. This is the case with the
58 default branch C<blead> which will be configured to merge from the
59 remote tracking branch C<origin/blead>.
60
61 You can see recent commits:
62
63   % git log
64
65 And pull new changes from the repository, and update your local
66 repository (must be clean first)
67
68   % git pull
69
70 Assuming we are on the branch C<blead> immediately after a pull, this
71 command would be more or less equivalent to:
72
73   % git fetch
74   % git merge origin/blead
75
76 In fact if you want to update your local repository without touching
77 your working directory you do:
78
79   % git fetch
80
81 And if you want to update your remote-tracking branches for all defined
82 remotes simultaneously you can do
83
84   % git remote update
85
86 Neither of these last two commands will update your working directory,
87 however both will update the remote-tracking branches in your
88 repository.
89
90 To make a local branch of a remote branch:
91
92   % git checkout -b maint-5.10 origin/maint-5.10
93
94 To switch back to blead:
95
96   % git checkout blead
97
98 =head2 Finding out your status
99
100 The most common git command you will use will probably be
101
102   % git status
103
104 This command will produce as output a description of the current state
105 of the repository, including modified files and unignored untracked
106 files, and in addition it will show things like what files have been
107 staged for the next commit, and usually some useful information about
108 how to change things. For instance the following:
109
110   $ git status
111   # On branch blead
112   # Your branch is ahead of 'origin/blead' by 1 commit.
113   #
114   # Changes to be committed:
115   #   (use "git reset HEAD <file>..." to unstage)
116   #
117   #       modified:   pod/perlgit.pod
118   #
119   # Changed but not updated:
120   #   (use "git add <file>..." to update what will be committed)
121   #
122   #       modified:   pod/perlgit.pod
123   #
124   # Untracked files:
125   #   (use "git add <file>..." to include in what will be committed)
126   #
127   #       deliberate.untracked
128
129 This shows that there were changes to this document staged for commit,
130 and that there were further changes in the working directory not yet
131 staged. It also shows that there was an untracked file in the working
132 directory, and as you can see shows how to change all of this. It also
133 shows that there is one commit on the working branch C<blead> which has
134 not been pushed to the C<origin> remote yet. B<NOTE>: that this output
135 is also what you see as a template if you do not provide a message to
136 C<git commit>.
137
138 =head2 Patch workflow
139
140 First, please read L<perlhack> for details on hacking the Perl core.
141 That document covers many details on how to create a good patch.
142
143 If you already have a Perl repository, you should ensure that you're on
144 the I<blead> branch, and your repository is up to date:
145
146   % git checkout blead
147   % git pull
148
149 It's preferable to patch against the latest blead version, since this
150 is where new development occurs for all changes other than critical bug
151 fixes. Critical bug fix patches should be made against the relevant
152 maint branches, or should be submitted with a note indicating all the
153 branches where the fix should be applied.
154
155 Now that we have everything up to date, we need to create a temporary
156 new branch for these changes and switch into it:
157
158   % git checkout -b orange
159
160 which is the short form of
161
162   % git branch orange
163   % git checkout orange
164
165 Creating a topic branch makes it easier for the maintainers to rebase
166 or merge back into the master blead for a more linear history. If you
167 don't work on a topic branch the maintainer has to manually cherry pick
168 your changes onto blead before they can be applied.
169
170 That'll get you scolded on perl5-porters, so don't do that. Be Awesome.
171
172 Then make your changes. For example, if Leon Brocard changes his name
173 to Orange Brocard, we should change his name in the AUTHORS file:
174
175   % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
176
177 You can see what files are changed:
178
179   % git status
180   # On branch orange
181   # Changes to be committed:
182   #   (use "git reset HEAD <file>..." to unstage)
183   #
184   #    modified:   AUTHORS
185   #
186
187 And you can see the changes:
188
189   % git diff
190   diff --git a/AUTHORS b/AUTHORS
191   index 293dd70..722c93e 100644
192   --- a/AUTHORS
193   +++ b/AUTHORS
194   @@ -541,7 +541,7 @@    Lars Hecking                   <lhecking@nmrc.ucc.ie>
195    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
196    Leif Huhn                      <leif@hale.dkstat.com>
197    Len Johnson                    <lenjay@ibm.net>
198   -Leon Brocard                   <acme@astray.com>
199   +Orange Brocard                 <acme@astray.com>
200    Les Peters                     <lpeters@aol.net>
201    Lesley Binks                   <lesley.binks@gmail.com>
202    Lincoln D. Stein               <lstein@cshl.org>
203
204 Now commit your change locally:
205
206   % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
207   Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
208    1 files changed, 1 insertions(+), 1 deletions(-)
209
210 The C<-a> option is used to include all files that git tracks that you
211 have changed. If at this time, you only want to commit some of the
212 files you have worked on, you can omit the C<-a> and use the command
213 C<S<git add I<FILE ...>>> before doing the commit. C<S<git add
214 --interactive>> allows you to even just commit portions of files
215 instead of all the changes in them.
216
217 The C<-m> option is used to specify the commit message. If you omit it,
218 git will open a text editor for you to compose the message
219 interactively. This is useful when the changes are more complex than
220 the sample given here, and, depending on the editor, to know that the
221 first line of the commit message doesn't exceed the 50 character legal
222 maximum.
223
224 Once you've finished writing your commit message and exited your
225 editor, git will write your change to disk and tell you something like
226 this:
227
228   Created commit daf8e63: explain git status and stuff about remotes
229    1 files changed, 83 insertions(+), 3 deletions(-)
230
231 If you re-run C<git status>, you should see something like this:
232
233   % git status
234   # On branch blead
235   # Your branch is ahead of 'origin/blead' by 2 commits.
236   #
237   # Untracked files:
238   #   (use "git add <file>..." to include in what will be committed)
239   #
240   #       deliberate.untracked
241   nothing added to commit but untracked files present (use "git add" to track)
242
243 When in doubt, before you do anything else, check your status and read
244 it carefully, many questions are answered directly by the git status
245 output.
246
247 You can examine your last commit with:
248
249   % git show HEAD
250
251 and if you are not happy with either the description or the patch
252 itself you can fix it up by editing the files once more and then issue:
253
254   % git commit -a --amend
255
256 Now you should create a patch file for all your local changes:
257
258   % git format-patch -M origin..
259   0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
260
261 You should now send an email to
262 L<perlbug@perl.org|mailto:perlbug@perl.org> with a description of your
263 changes, and include this patch file as an attachment. In addition to
264 being tracked by RT, mail to perlbug will automatically be forwarded to
265 perl5-porters (with manual moderation, so please be patient). You
266 should only send patches to
267 L<perl5-porters@perl.org|mailto:perl5-porters@perl.org> directly if the
268 patch is not ready to be applied, but intended for discussion.
269
270 See the next section for how to configure and use git to send these
271 emails for you.
272
273 If you want to delete your temporary branch, you may do so with:
274
275   % git checkout blead
276   % git branch -d orange
277   error: The branch 'orange' is not an ancestor of your current HEAD.
278   If you are sure you want to delete it, run 'git branch -D orange'.
279   % git branch -D orange
280   Deleted branch orange.
281
282 =head2 Committing your changes
283
284 Assuming that you'd like to commit all the changes you've made as a
285 single atomic unit, run this command:
286
287    % git commit -a
288
289 (That C<-a> tells git to add every file you've changed to this commit.
290 New files aren't automatically added to your commit when you use
291 C<commit -a> If you want to add files or to commit some, but not all of
292 your changes, have a look at the documentation for C<git add>.)
293
294 Git will start up your favorite text editor, so that you can craft a
295 commit message for your change. See L<perlhack/Commit message> for more
296 information about what makes a good commit message.
297
298 Once you've finished writing your commit message and exited your
299 editor, git will write your change to disk and tell you something like
300 this:
301
302   Created commit daf8e63: explain git status and stuff about remotes
303    1 files changed, 83 insertions(+), 3 deletions(-)
304
305 If you re-run C<git status>, you should see something like this:
306
307   % git status
308   # On branch blead
309   # Your branch is ahead of 'origin/blead' by 2 commits.
310   #
311   # Untracked files:
312   #   (use "git add <file>..." to include in what will be committed)
313   #
314   #       deliberate.untracked
315   nothing added to commit but untracked files present (use "git add" to track)
316
317 When in doubt, before you do anything else, check your status and read
318 it carefully, many questions are answered directly by the git status
319 output.
320
321 =head2 Using git to send patch emails
322
323 Please read L<perlhack> first in order to figure out where your patches
324 should be sent.
325
326 In your ~/git/perl repository, set the destination email to perl's bug
327 tracker:
328
329   $ git config sendemail.to perlbug@perl.org
330
331 Or maybe perl5-porters:
332
333   $ git config sendemail.to perl5-porters@perl.org
334
335 Then you can use git directly to send your patch emails:
336
337   $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
338
339 You may need to set some configuration variables for your particular
340 email service provider. For example, to set your global git config to
341 send email via a gmail account:
342
343   $ git config --global sendemail.smtpserver smtp.gmail.com
344   $ git config --global sendemail.smtpssl 1
345   $ git config --global sendemail.smtpuser YOURUSERNAME@gmail.com
346
347 With this configuration, you will be prompted for your gmail password
348 when you run 'git send-email'. You can also configure
349 C<sendemail.smtppass> with your password if you don't care about having
350 your password in the .gitconfig file.
351
352 =head2 A note on derived files
353
354 Be aware that many files in the distribution are derivative--avoid
355 patching them, because git won't see the changes to them, and the build
356 process will overwrite them. Patch the originals instead. Most
357 utilities (like perldoc) are in this category, i.e. patch
358 F<utils/perldoc.PL> rather than F<utils/perldoc>. Similarly, don't
359 create patches for files under $src_root/ext from their copies found in
360 $install_root/lib. If you are unsure about the proper location of a
361 file that may have gotten copied while building the source
362 distribution, consult the C<MANIFEST>.
363
364 =head2 Cleaning a working directory
365
366 The command C<git clean> can with varying arguments be used as a
367 replacement for C<make clean>.
368
369 To reset your working directory to a pristine condition you can do:
370
371   % git clean -dxf
372
373 However, be aware this will delete ALL untracked content. You can use
374
375   % git clean -Xf
376
377 to remove all ignored untracked files, such as build and test
378 byproduct, but leave any  manually created files alone.
379
380 If you only want to cancel some uncommitted edits, you can use C<git
381 checkout> and give it a list of files to be reverted, or C<git checkout
382 -f> to revert them all.
383
384 If you want to cancel one or several commits, you can use C<git reset>.
385
386 =head2 Bisecting
387
388 C<git> provides a built-in way to determine, with a binary search in
389 the history, which commit should be blamed for introducing a given bug.
390
391 Suppose that we have a script F<~/testcase.pl> that exits with C<0>
392 when some behaviour is correct, and with C<1> when it's faulty. You
393 need an helper script that automates building C<perl> and running the
394 testcase. For an example script, see F<Porting/bisect-example.sh>, which
395 you should copy B<outside> of the repository as the bisect process will
396 reset the state to a clean checkout as it runs. The instructions below assume
397 that you copied it as F<~/run> and then edited as appropriate.
398
399 This script may return C<125> to indicate that the corresponding commit
400 should be skipped. Otherwise, it returns the status of
401 F<~/testcase.pl>.
402
403 You first enter in bisect mode with:
404
405   % git bisect start
406
407 For example, if the bug is present on C<HEAD> but wasn't in 5.10.0,
408 C<git> will learn about this when you enter:
409
410   % git bisect bad
411   % git bisect good perl-5.10.0
412   Bisecting: 853 revisions left to test after this
413
414 This results in checking out the median commit between C<HEAD> and
415 C<perl-5.10.0>. You can then run the bisecting process with:
416
417   % git bisect run ~/run
418
419 When the first bad commit is isolated, C<git bisect> will tell you so:
420
421   ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit
422   commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5
423   Author: Dave Mitchell <davem@fdisolutions.com>
424   Date:   Sat Feb 9 14:56:23 2008 +0000
425
426       [perl #49472] Attributes + Unknown Error
427       ...
428
429   bisect run success
430
431 You can peek into the bisecting process with C<git bisect log> and
432 C<git bisect visualize>. C<git bisect reset> will get you out of bisect
433 mode.
434
435 Please note that the first C<good> state must be an ancestor of the
436 first C<bad> state. If you want to search for the commit that I<solved>
437 some bug, you have to negate your test case (i.e. exit with C<1> if OK
438 and C<0> if not) and still mark the lower bound as C<good> and the
439 upper as C<bad>. The "first bad commit" has then to be understood as
440 the "first commit where the bug is solved".
441
442 C<git help bisect> has much more information on how you can tweak your
443 binary searches.
444
445 =head1 Topic branches and rewriting history
446
447 Individual committers should create topic branches under
448 B<yourname>/B<some_descriptive_name>. Other committers should check
449 with a topic branch's creator before making any change to it.
450
451 The simplest way to create a remote topic branch that works on all
452 versions of git is to push the current head as a new branch on the
453 remote, then check it out locally:
454
455   $ branch="$yourname/$some_descriptive_name"
456   $ git push origin HEAD:$branch
457   $ git checkout -b $branch origin/$branch
458
459 Users of git 1.7 or newer can do it in a more obvious manner:
460
461   $ branch="$yourname/$some_descriptive_name"
462   $ git checkout -b $branch
463   $ git push origin -u $branch
464
465 If you are not the creator of B<yourname>/B<some_descriptive_name>, you
466 might sometimes find that the original author has edited the branch's
467 history. There are lots of good reasons for this. Sometimes, an author
468 might simply be rebasing the branch onto a newer source point.
469 Sometimes, an author might have found an error in an early commit which
470 they wanted to fix before merging the branch to blead.
471
472 Currently the master repository is configured to forbid
473 non-fast-forward merges. This means that the branches within can not be
474 rebased and pushed as a single step.
475
476 The only way you will ever be allowed to rebase or modify the history
477 of a pushed branch is to delete it and push it as a new branch under
478 the same name. Please think carefully about doing this. It may be
479 better to sequentially rename your branches so that it is easier for
480 others working with you to cherry-pick their local changes onto the new
481 version. (XXX: needs explanation).
482
483 If you want to rebase a personal topic branch, you will have to delete
484 your existing topic branch and push as a new version of it. You can do
485 this via the following formula (see the explanation about C<refspec>'s
486 in the git push documentation for details) after you have rebased your
487 branch:
488
489    # first rebase
490    $ git checkout $user/$topic
491    $ git fetch
492    $ git rebase origin/blead
493
494    # then "delete-and-push"
495    $ git push origin :$user/$topic
496    $ git push origin $user/$topic
497
498 B<NOTE:> it is forbidden at the repository level to delete any of the
499 "primary" branches. That is any branch matching
500 C<m!^(blead|maint|perl)!>. Any attempt to do so will result in git
501 producing an error like this:
502
503     $ git push origin :blead
504     *** It is forbidden to delete blead/maint branches in this repository
505     error: hooks/update exited with error code 1
506     error: hook declined to update refs/heads/blead
507     To ssh://perl5.git.perl.org/perl
508      ! [remote rejected] blead (hook declined)
509      error: failed to push some refs to 'ssh://perl5.git.perl.org/perl'
510
511 As a matter of policy we do B<not> edit the history of the blead and
512 maint-* branches. If a typo (or worse) sneaks into a commit to blead or
513 maint-*, we'll fix it in another commit. The only types of updates
514 allowed on these branches are "fast-forward's", where all history is
515 preserved.
516
517 Annotated tags in the canonical perl.git repository will never be
518 deleted or modified. Think long and hard about whether you want to push
519 a local tag to perl.git before doing so. (Pushing unannotated tags is
520 not allowed.)
521
522 =head2 Grafts
523
524 The perl history contains one mistake which was not caught in the
525 conversion: a merge was recorded in the history between blead and
526 maint-5.10 where no merge actually occurred. Due to the nature of git,
527 this is now impossible to fix in the public repository. You can remove
528 this mis-merge locally by adding the following line to your
529 C<.git/info/grafts> file:
530
531   296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930
532
533 It is particularly important to have this graft line if any bisecting
534 is done in the area of the "merge" in question.
535
536 =head1 WRITE ACCESS TO THE GIT REPOSITORY
537
538 Once you have write access, you will need to modify the URL for the
539 origin remote to enable pushing. Edit F<.git/config> with the
540 git-config(1) command:
541
542   % git config remote.origin.url ssh://perl5.git.perl.org/perl.git
543
544 You can also set up your user name and e-mail address. Most people do
545 this once globally in their F<~/.gitconfig> by doing something like:
546
547   % git config --global user.name "Ævar Arnfjörð Bjarmason"
548   % git config --global user.email avarab@gmail.com
549
550 However if you'd like to override that just for perl then execute then
551 execute something like the following in F<perl>:
552
553   % git config user.email avar@cpan.org
554
555 It is also possible to keep C<origin> as a git remote, and add a new
556 remote for ssh access:
557
558   % git remote add camel perl5.git.perl.org:/perl.git
559
560 This allows you to update your local repository by pulling from
561 C<origin>, which is faster and doesn't require you to authenticate, and
562 to push your changes back with the C<camel> remote:
563
564   % git fetch camel
565   % git push camel
566
567 The C<fetch> command just updates the C<camel> refs, as the objects
568 themselves should have been fetched when pulling from C<origin>.
569
570 =head1 Accepting a patch
571
572 If you have received a patch file generated using the above section,
573 you should try out the patch.
574
575 First we need to create a temporary new branch for these changes and
576 switch into it:
577
578   % git checkout -b experimental
579
580 Patches that were formatted by C<git format-patch> are applied with
581 C<git am>:
582
583   % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
584   Applying Rename Leon Brocard to Orange Brocard
585
586 If just a raw diff is provided, it is also possible use this two-step
587 process:
588
589   % git apply bugfix.diff
590   % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>"
591
592 Now we can inspect the change:
593
594   % git show HEAD
595   commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
596   Author: Leon Brocard <acme@astray.com>
597   Date:   Fri Dec 19 17:02:59 2008 +0000
598
599     Rename Leon Brocard to Orange Brocard
600
601   diff --git a/AUTHORS b/AUTHORS
602   index 293dd70..722c93e 100644
603   --- a/AUTHORS
604   +++ b/AUTHORS
605   @@ -541,7 +541,7 @@ Lars Hecking                        <lhecking@nmrc.ucc.ie>
606    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
607    Leif Huhn                      <leif@hale.dkstat.com>
608    Len Johnson                    <lenjay@ibm.net>
609   -Leon Brocard                   <acme@astray.com>
610   +Orange Brocard                 <acme@astray.com>
611    Les Peters                     <lpeters@aol.net>
612    Lesley Binks                   <lesley.binks@gmail.com>
613    Lincoln D. Stein               <lstein@cshl.org>
614
615 If you are a committer to Perl and you think the patch is good, you can
616 then merge it into blead then push it out to the main repository:
617
618   % git checkout blead
619   % git merge experimental
620   % git push
621
622 If you want to delete your temporary branch, you may do so with:
623
624   % git checkout blead
625   % git branch -d experimental
626   error: The branch 'experimental' is not an ancestor of your current HEAD.
627   If you are sure you want to delete it, run 'git branch -D experimental'.
628   % git branch -D experimental
629   Deleted branch experimental.
630
631 =head2 Committing to blead
632
633 The 'blead' branch will become the next production release of Perl.
634
635 Before pushing I<any> local change to blead, it's incredibly important
636 that you do a few things, lest other committers come after you with
637 pitchforks and torches:
638
639 =over
640
641 =item *
642
643 Make sure you have a good commit message. See L<perlhack/Commit
644 message> for details.
645
646 =item *
647
648 Run the test suite. You might not think that one typo fix would break a
649 test file. You'd be wrong. Here's an example of where not running the
650 suite caused problems. A patch was submitted that added a couple of
651 tests to an existing .t. It couldn't possibly affect anything else, so
652 no need to test beyond the single affected .t, right?  But, the
653 submitter's email address had changed since the last of their
654 submissions, and this caused other tests to fail. Running the test
655 target given in the next item would have caught this problem.
656
657 =item *
658
659 If you don't run the full test suite, at least C<make test_porting>.
660 This will run basic sanity checks. To see which sanity checks, have a
661 look in F<t/porting>.
662
663 =item *
664
665 If you make any changes that affect miniperl or core routines that have
666 different code paths for miniperl, be sure to run C<make minitest>.
667 This will catch problems that even the full test suite will not catch
668 because it runs a subset of tests under miniperl rather than perl.
669
670 =back
671
672 =head3 On merging and rebasing
673
674 Simple, one-off commits pushed to the 'blead' branch should be simple
675 commits that apply cleanly.  In other words, you should make sure your
676 work is committed against the current position of blead, so that you can
677 push back to the master repository without merging.
678
679 Sometimes, blead will move while you're building or testing your
680 changes.  When this happens, your push will be rejected with a message
681 like this:
682
683   To ssh://perl5.git.perl.org/perl.git
684    ! [rejected]        blead -> blead (non-fast-forward)
685   error: failed to push some refs to 'ssh://perl5.git.perl.org/perl.git'
686   To prevent you from losing history, non-fast-forward updates were rejected
687   Merge the remote changes (e.g. 'git pull') before pushing again.  See the
688   'Note about fast-forwards' section of 'git push --help' for details.
689
690 When this happens, you can just I<rebase> your work against the new
691 position of blead, like this (assuming your remote for the master
692 repository is "p5p"):
693
694   $ git fetch p5p
695   $ git rebase p5p/blead
696
697 You will see your commits being re-applied, and you will then be able to
698 push safely.  More information about rebasing can be found in the
699 documentation for the git-rebase(1) command.
700
701 For larger sets of commits that only make sense together, or that would
702 benefit from a summary of the set's purpose, you should use a merge
703 commit.  You should perform your work on a L<topic branch|/Topic
704 branches and rewriting history>, which you should regularly rebase
705 against blead to ensure that your code is not broken by blead moving.
706 When you have finished your work, please perform a final rebase and
707 test.  Linear history is something that gets lost with every
708 commit on blead, but a final rebase makes the history linear
709 again, making it easier for future maintainers to see what has
710 happened.  Rebase as follows (assuming your work was on the
711 branch C<< committer/somework >>):
712
713   $ git checkout committer/somework
714   $ git rebase blead
715
716 Then you can merge it into master like this:
717
718   $ git checkout blead
719   $ git merge --no-ff --no-commit committer/somework
720   $ git commit -a
721
722 The switches above deserve explanation.  C<--no-ff> indicates that even
723 if all your work can be applied linearly against blead, a merge commit
724 should still be prepared.  This ensures that all your work will be shown
725 as a side branch, with all its commits merged into the mainstream blead
726 by the merge commit.
727
728 C<--no-commit> means that the merge commit will be I<prepared> but not
729 I<committed>.  The commit is then actually performed when you run the
730 next command, which will bring up your editor to describe the commit.
731 Without C<--no-commit>, the commit would be made with nearly no useful
732 message, which would greatly diminish the value of the merge commit as a
733 placeholder for the work's description.
734
735 When describing the merge commit, explain the purpose of the branch, and
736 keep in mind that this description will probably be used by the
737 eventual release engineer when reviewing the next perldelta document.
738
739 =head2 Committing to maintenance versions
740
741 Maintenance versions should only be altered to add critical bug fixes,
742 see L<perlpolicy>.
743
744 To commit to a maintenance version of perl, you need to create a local
745 tracking branch:
746
747   % git checkout --track -b maint-5.005 origin/maint-5.005
748
749 This creates a local branch named C<maint-5.005>, which tracks the
750 remote branch C<origin/maint-5.005>. Then you can pull, commit, merge
751 and push as before.
752
753 You can also cherry-pick commits from blead and another branch, by
754 using the C<git cherry-pick> command. It is recommended to use the
755 B<-x> option to C<git cherry-pick> in order to record the SHA1 of the
756 original commit in the new commit message.
757
758 Before pushing any change to a maint version, make sure you've
759 satisfied the steps in L</Committing to blead> above.
760
761 =head2 Merging from a branch via GitHub
762
763 While we don't encourage the submission of patches via GitHub, that
764 will still happen. Here is a guide to merging patches from a GitHub
765 repository.
766
767   % git remote add avar git://github.com/avar/perl.git
768   % git fetch avar
769
770 Now you can see the differences between the branch and blead:
771
772   % git diff avar/orange
773
774 And you can see the commits:
775
776   % git log avar/orange
777
778 If you approve of a specific commit, you can cherry pick it:
779
780   % git cherry-pick 0c24b290ae02b2ab3304f51d5e11e85eb3659eae
781
782 Or you could just merge the whole branch if you like it all:
783
784   % git merge avar/orange
785
786 And then push back to the repository:
787
788   % git push
789
790 =head2 A note on camel and dromedary
791
792 The committers have SSH access to the two servers that serve
793 C<perl5.git.perl.org>. One is C<perl5.git.perl.org> itself (I<camel>),
794 which is the 'master' repository. The second one is
795 C<users.perl5.git.perl.org> (I<dromedary>), which can be used for
796 general testing and development. Dromedary syncs the git tree from
797 camel every few minutes, you should not push there. Both machines also
798 have a full CPAN mirror in /srv/CPAN, please use this. To share files
799 with the general public, dromedary serves your ~/public_html/ as
800 C<http://users.perl5.git.perl.org/~yourlogin/>
801
802 These hosts have fairly strict firewalls to the outside. Outgoing, only
803 rsync, ssh and git are allowed. For http and ftp, you can use
804 http://webproxy:3128 as proxy. Incoming, the firewall tries to detect
805 attacks and blocks IP addresses with suspicious activity. This
806 sometimes (but very rarely) has false positives and you might get
807 blocked. The quickest way to get unblocked is to notify the admins.
808
809 These two boxes are owned, hosted, and operated by booking.com. You can
810 reach the sysadmins in #p5p on irc.perl.org or via mail to
811 C<perl5-porters@perl.org>.