4 Consistent formatting of this file is achieved with:
5 perl ./Porting/podtidy pod/perlgit.pod
9 perlgit - Detailed information about git and the Perl repository
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.
18 =head1 CLONING THE REPOSITORY
20 All of Perl's source code is kept centrally in a Git repository at
21 I<perl5.git.perl.org>.
23 You can make a read-only clone of the repository by running:
25 % git clone git://perl5.git.perl.org/perl.git perl
27 This uses the git protocol (port 9418).
29 If you cannot use the git protocol for firewall reasons, you can also
30 clone via http, though this is much slower:
32 % git clone http://perl5.git.perl.org/perl.git perl
34 =head1 WORKING WITH THE REPOSITORY
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.
43 Using the -a switch to C<branch> will also show the remote tracking
44 branches in the repository:
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>.
61 You can see recent commits:
65 And pull new changes from the repository, and update your local
66 repository (must be clean first)
70 Assuming we are on the branch C<blead> immediately after a pull, this
71 command would be more or less equivalent to:
74 % git merge origin/blead
76 In fact if you want to update your local repository without touching
77 your working directory you do:
81 And if you want to update your remote-tracking branches for all defined
82 remotes simultaneously you can do
86 Neither of these last two commands will update your working directory,
87 however both will update the remote-tracking branches in your
90 To make a local branch of a remote branch:
92 % git checkout -b maint-5.10 origin/maint-5.10
94 To switch back to blead:
98 =head2 Finding out your status
100 The most common git command you will use will probably be
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:
112 # Your branch is ahead of 'origin/blead' by 1 commit.
114 # Changes to be committed:
115 # (use "git reset HEAD <file>..." to unstage)
117 # modified: pod/perlgit.pod
119 # Changed but not updated:
120 # (use "git add <file>..." to update what will be committed)
122 # modified: pod/perlgit.pod
125 # (use "git add <file>..." to include in what will be committed)
127 # deliberate.untracked
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
138 =head2 Patch workflow
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.
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:
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.
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:
158 % git checkout -b orange
160 which is the short form of
163 % git checkout orange
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.
170 That'll get you scolded on perl5-porters, so don't do that. Be Awesome.
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:
175 % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
177 You can see what files are changed:
181 # Changes to be committed:
182 # (use "git reset HEAD <file>..." to unstage)
187 And you can see the changes:
190 diff --git a/AUTHORS b/AUTHORS
191 index 293dd70..722c93e 100644
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>
204 Now commit your change locally:
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(-)
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.
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
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
228 Created commit daf8e63: explain git status and stuff about remotes
229 1 files changed, 83 insertions(+), 3 deletions(-)
231 If you re-run C<git status>, you should see something like this:
235 # Your branch is ahead of 'origin/blead' by 2 commits.
238 # (use "git add <file>..." to include in what will be committed)
240 # deliberate.untracked
241 nothing added to commit but untracked files present (use "git add" to track)
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
247 You can examine your last commit with:
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:
254 % git commit -a --amend
256 Now you should create a patch file for all your local changes:
258 % git format-patch -M origin..
259 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
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.
270 See the next section for how to configure and use git to send these
273 If you want to delete your temporary branch, you may do so with:
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.
282 =head2 Committing your changes
284 Assuming that you'd like to commit all the changes you've made as a
285 single atomic unit, run this command:
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>.)
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.
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
302 Created commit daf8e63: explain git status and stuff about remotes
303 1 files changed, 83 insertions(+), 3 deletions(-)
305 If you re-run C<git status>, you should see something like this:
309 # Your branch is ahead of 'origin/blead' by 2 commits.
312 # (use "git add <file>..." to include in what will be committed)
314 # deliberate.untracked
315 nothing added to commit but untracked files present (use "git add" to track)
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
321 =head2 Using git to send patch emails
323 Please read L<perlhack> first in order to figure out where your patches
326 In your ~/git/perl repository, set the destination email to perl's bug
329 $ git config sendemail.to perlbug@perl.org
331 Or maybe perl5-porters:
333 $ git config sendemail.to perl5-porters@perl.org
335 Then you can use git directly to send your patch emails:
337 $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
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:
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
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.
352 =head2 A note on derived files
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>.
364 =head2 Cleaning a working directory
366 The command C<git clean> can with varying arguments be used as a
367 replacement for C<make clean>.
369 To reset your working directory to a pristine condition you can do:
373 However, be aware this will delete ALL untracked content. You can use
377 to remove all ignored untracked files, such as build and test
378 byproduct, but leave any manually created files alone.
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.
384 If you want to cancel one or several commits, you can use C<git reset>.
388 C<git> provides a built-in way to determine which commit should be blamed
389 for introducing a given bug. C<git bisect> performs a binary search of
390 history to locate the first failing commit. It is fast, powerful and
391 flexible, but requires some setup and to automate the process an auxiliary
392 shell script is needed.
394 The core provides a wrapper program, F<Porting/bisect.pl>, which attempts to
395 simplify as much as possible, making bisecting as simple as running a Perl
396 one-liner. For example, if you want to know when this became an error:
402 .../Porting/bisect.pl -e 'my $a := 2;'
404 Using C<bisect.pl>, with one command (and no other files) it's easy to find
411 Which commit caused this example code to break?
415 Which commit caused this example code to start working?
419 Which commit added the first file to match this regex?
423 Which commit removed the last file to match this regex?
427 usually without needing to know which versions of perl to use as start and
428 end revisions, as F<bisect.pl> automatically searches to find the earliest
429 stable version for which the test case passes. Run
430 C<Porting/bisect.pl --help> for the full documentation, including how to
431 set the C<Configure> and build time options.
433 If you require more flexibility than F<Porting/bisect.pl> has to offer, you'll
434 need to run C<git bisect> yourself. It's most useful to use C<git bisect run>
435 to automate the building and testing of perl revisions. For this you'll need
436 a shell script for C<git> to call to test a particular revision. An example
437 script is F<Porting/bisect-example.sh>, which you should copy B<outside> of
438 the repository, as the bisect process will reset the state to a clean checkout
439 as it runs. The instructions below assume that you copied it as F<~/run> and
440 then edited it as appropriate.
442 You first enter in bisect mode with:
446 For example, if the bug is present on C<HEAD> but wasn't in 5.10.0,
447 C<git> will learn about this when you enter:
450 % git bisect good perl-5.10.0
451 Bisecting: 853 revisions left to test after this
453 This results in checking out the median commit between C<HEAD> and
454 C<perl-5.10.0>. You can then run the bisecting process with:
456 % git bisect run ~/run
458 When the first bad commit is isolated, C<git bisect> will tell you so:
460 ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit
461 commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5
462 Author: Dave Mitchell <davem@fdisolutions.com>
463 Date: Sat Feb 9 14:56:23 2008 +0000
465 [perl #49472] Attributes + Unknown Error
470 You can peek into the bisecting process with C<git bisect log> and
471 C<git bisect visualize>. C<git bisect reset> will get you out of bisect
474 Please note that the first C<good> state must be an ancestor of the
475 first C<bad> state. If you want to search for the commit that I<solved>
476 some bug, you have to negate your test case (i.e. exit with C<1> if OK
477 and C<0> if not) and still mark the lower bound as C<good> and the
478 upper as C<bad>. The "first bad commit" has then to be understood as
479 the "first commit where the bug is solved".
481 C<git help bisect> has much more information on how you can tweak your
484 =head2 Topic branches and rewriting history
486 Individual committers should create topic branches under
487 B<yourname>/B<some_descriptive_name>. Other committers should check
488 with a topic branch's creator before making any change to it.
490 The simplest way to create a remote topic branch that works on all
491 versions of git is to push the current head as a new branch on the
492 remote, then check it out locally:
494 $ branch="$yourname/$some_descriptive_name"
495 $ git push origin HEAD:$branch
496 $ git checkout -b $branch origin/$branch
498 Users of git 1.7 or newer can do it in a more obvious manner:
500 $ branch="$yourname/$some_descriptive_name"
501 $ git checkout -b $branch
502 $ git push origin -u $branch
504 If you are not the creator of B<yourname>/B<some_descriptive_name>, you
505 might sometimes find that the original author has edited the branch's
506 history. There are lots of good reasons for this. Sometimes, an author
507 might simply be rebasing the branch onto a newer source point.
508 Sometimes, an author might have found an error in an early commit which
509 they wanted to fix before merging the branch to blead.
511 Currently the master repository is configured to forbid
512 non-fast-forward merges. This means that the branches within can not be
513 rebased and pushed as a single step.
515 The only way you will ever be allowed to rebase or modify the history
516 of a pushed branch is to delete it and push it as a new branch under
517 the same name. Please think carefully about doing this. It may be
518 better to sequentially rename your branches so that it is easier for
519 others working with you to cherry-pick their local changes onto the new
520 version. (XXX: needs explanation).
522 If you want to rebase a personal topic branch, you will have to delete
523 your existing topic branch and push as a new version of it. You can do
524 this via the following formula (see the explanation about C<refspec>'s
525 in the git push documentation for details) after you have rebased your
529 $ git checkout $user/$topic
531 $ git rebase origin/blead
533 # then "delete-and-push"
534 $ git push origin :$user/$topic
535 $ git push origin $user/$topic
537 B<NOTE:> it is forbidden at the repository level to delete any of the
538 "primary" branches. That is any branch matching
539 C<m!^(blead|maint|perl)!>. Any attempt to do so will result in git
540 producing an error like this:
542 $ git push origin :blead
543 *** It is forbidden to delete blead/maint branches in this repository
544 error: hooks/update exited with error code 1
545 error: hook declined to update refs/heads/blead
546 To ssh://perl5.git.perl.org/perl
547 ! [remote rejected] blead (hook declined)
548 error: failed to push some refs to 'ssh://perl5.git.perl.org/perl'
550 As a matter of policy we do B<not> edit the history of the blead and
551 maint-* branches. If a typo (or worse) sneaks into a commit to blead or
552 maint-*, we'll fix it in another commit. The only types of updates
553 allowed on these branches are "fast-forward's", where all history is
556 Annotated tags in the canonical perl.git repository will never be
557 deleted or modified. Think long and hard about whether you want to push
558 a local tag to perl.git before doing so. (Pushing unannotated tags is
563 The perl history contains one mistake which was not caught in the
564 conversion: a merge was recorded in the history between blead and
565 maint-5.10 where no merge actually occurred. Due to the nature of git,
566 this is now impossible to fix in the public repository. You can remove
567 this mis-merge locally by adding the following line to your
568 C<.git/info/grafts> file:
570 296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930
572 It is particularly important to have this graft line if any bisecting
573 is done in the area of the "merge" in question.
575 =head1 WRITE ACCESS TO THE GIT REPOSITORY
577 Once you have write access, you will need to modify the URL for the
578 origin remote to enable pushing. Edit F<.git/config> with the
579 git-config(1) command:
581 % git config remote.origin.url ssh://perl5.git.perl.org/perl.git
583 You can also set up your user name and e-mail address. Most people do
584 this once globally in their F<~/.gitconfig> by doing something like:
586 % git config --global user.name "Ævar Arnfjörð Bjarmason"
587 % git config --global user.email avarab@gmail.com
589 However, if you'd like to override that just for perl,
590 execute something like the following in F<perl>:
592 % git config user.email avar@cpan.org
594 It is also possible to keep C<origin> as a git remote, and add a new
595 remote for ssh access:
597 % git remote add camel perl5.git.perl.org:/perl.git
599 This allows you to update your local repository by pulling from
600 C<origin>, which is faster and doesn't require you to authenticate, and
601 to push your changes back with the C<camel> remote:
606 The C<fetch> command just updates the C<camel> refs, as the objects
607 themselves should have been fetched when pulling from C<origin>.
609 =head2 Accepting a patch
611 If you have received a patch file generated using the above section,
612 you should try out the patch.
614 First we need to create a temporary new branch for these changes and
617 % git checkout -b experimental
619 Patches that were formatted by C<git format-patch> are applied with
622 % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
623 Applying Rename Leon Brocard to Orange Brocard
625 If just a raw diff is provided, it is also possible use this two-step
628 % git apply bugfix.diff
629 % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>"
631 Now we can inspect the change:
634 commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
635 Author: Leon Brocard <acme@astray.com>
636 Date: Fri Dec 19 17:02:59 2008 +0000
638 Rename Leon Brocard to Orange Brocard
640 diff --git a/AUTHORS b/AUTHORS
641 index 293dd70..722c93e 100644
644 @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie>
645 Laszlo Molnar <laszlo.molnar@eth.ericsson.se>
646 Leif Huhn <leif@hale.dkstat.com>
647 Len Johnson <lenjay@ibm.net>
648 -Leon Brocard <acme@astray.com>
649 +Orange Brocard <acme@astray.com>
650 Les Peters <lpeters@aol.net>
651 Lesley Binks <lesley.binks@gmail.com>
652 Lincoln D. Stein <lstein@cshl.org>
654 If you are a committer to Perl and you think the patch is good, you can
655 then merge it into blead then push it out to the main repository:
658 % git merge experimental
659 % git push origin blead
661 If you want to delete your temporary branch, you may do so with:
664 % git branch -d experimental
665 error: The branch 'experimental' is not an ancestor of your current HEAD.
666 If you are sure you want to delete it, run 'git branch -D experimental'.
667 % git branch -D experimental
668 Deleted branch experimental.
670 =head2 Committing to blead
672 The 'blead' branch will become the next production release of Perl.
674 Before pushing I<any> local change to blead, it's incredibly important
675 that you do a few things, lest other committers come after you with
676 pitchforks and torches:
682 Make sure you have a good commit message. See L<perlhack/Commit
683 message> for details.
687 Run the test suite. You might not think that one typo fix would break a
688 test file. You'd be wrong. Here's an example of where not running the
689 suite caused problems. A patch was submitted that added a couple of
690 tests to an existing .t. It couldn't possibly affect anything else, so
691 no need to test beyond the single affected .t, right? But, the
692 submitter's email address had changed since the last of their
693 submissions, and this caused other tests to fail. Running the test
694 target given in the next item would have caught this problem.
698 If you don't run the full test suite, at least C<make test_porting>.
699 This will run basic sanity checks. To see which sanity checks, have a
700 look in F<t/porting>.
704 If you make any changes that affect miniperl or core routines that have
705 different code paths for miniperl, be sure to run C<make minitest>.
706 This will catch problems that even the full test suite will not catch
707 because it runs a subset of tests under miniperl rather than perl.
711 =head2 On merging and rebasing
713 Simple, one-off commits pushed to the 'blead' branch should be simple
714 commits that apply cleanly. In other words, you should make sure your
715 work is committed against the current position of blead, so that you can
716 push back to the master repository without merging.
718 Sometimes, blead will move while you're building or testing your
719 changes. When this happens, your push will be rejected with a message
722 To ssh://perl5.git.perl.org/perl.git
723 ! [rejected] blead -> blead (non-fast-forward)
724 error: failed to push some refs to 'ssh://perl5.git.perl.org/perl.git'
725 To prevent you from losing history, non-fast-forward updates were rejected
726 Merge the remote changes (e.g. 'git pull') before pushing again. See the
727 'Note about fast-forwards' section of 'git push --help' for details.
729 When this happens, you can just I<rebase> your work against the new
730 position of blead, like this (assuming your remote for the master
731 repository is "p5p"):
734 $ git rebase p5p/blead
736 You will see your commits being re-applied, and you will then be able to
737 push safely. More information about rebasing can be found in the
738 documentation for the git-rebase(1) command.
740 For larger sets of commits that only make sense together, or that would
741 benefit from a summary of the set's purpose, you should use a merge
742 commit. You should perform your work on a L<topic branch|/Topic
743 branches and rewriting history>, which you should regularly rebase
744 against blead to ensure that your code is not broken by blead moving.
745 When you have finished your work, please perform a final rebase and
746 test. Linear history is something that gets lost with every
747 commit on blead, but a final rebase makes the history linear
748 again, making it easier for future maintainers to see what has
749 happened. Rebase as follows (assuming your work was on the
750 branch C<< committer/somework >>):
752 $ git checkout committer/somework
755 Then you can merge it into master like this:
758 $ git merge --no-ff --no-commit committer/somework
761 The switches above deserve explanation. C<--no-ff> indicates that even
762 if all your work can be applied linearly against blead, a merge commit
763 should still be prepared. This ensures that all your work will be shown
764 as a side branch, with all its commits merged into the mainstream blead
767 C<--no-commit> means that the merge commit will be I<prepared> but not
768 I<committed>. The commit is then actually performed when you run the
769 next command, which will bring up your editor to describe the commit.
770 Without C<--no-commit>, the commit would be made with nearly no useful
771 message, which would greatly diminish the value of the merge commit as a
772 placeholder for the work's description.
774 When describing the merge commit, explain the purpose of the branch, and
775 keep in mind that this description will probably be used by the
776 eventual release engineer when reviewing the next perldelta document.
778 =head2 Committing to maintenance versions
780 Maintenance versions should only be altered to add critical bug fixes,
783 To commit to a maintenance version of perl, you need to create a local
786 % git checkout --track -b maint-5.005 origin/maint-5.005
788 This creates a local branch named C<maint-5.005>, which tracks the
789 remote branch C<origin/maint-5.005>. Then you can pull, commit, merge
792 You can also cherry-pick commits from blead and another branch, by
793 using the C<git cherry-pick> command. It is recommended to use the
794 B<-x> option to C<git cherry-pick> in order to record the SHA1 of the
795 original commit in the new commit message.
797 Before pushing any change to a maint version, make sure you've
798 satisfied the steps in L</Committing to blead> above.
800 =head2 Merging from a branch via GitHub
802 While we don't encourage the submission of patches via GitHub, that
803 will still happen. Here is a guide to merging patches from a GitHub
806 % git remote add avar git://github.com/avar/perl.git
809 Now you can see the differences between the branch and blead:
811 % git diff avar/orange
813 And you can see the commits:
815 % git log avar/orange
817 If you approve of a specific commit, you can cherry pick it:
819 % git cherry-pick 0c24b290ae02b2ab3304f51d5e11e85eb3659eae
821 Or you could just merge the whole branch if you like it all:
823 % git merge avar/orange
825 And then push back to the repository:
827 % git push origin blead
829 =head2 Using a smoke-me branch to test changes
831 Sometimes a change affects code paths which you cannot test on the OSes
832 which are directly available to you and it would be wise to have users
833 on other OSes test the change before you commit it to blead.
835 Fortunately, there is a way to get your change smoke-tested on various
836 OSes: push it to a "smoke-me" branch and wait for certain automated
837 smoke-testers to report the results from their OSes.
839 The procedure for doing this is roughly as follows (using the example of
840 of tonyc's smoke-me branch called win32stat):
842 First, make a local branch and switch to it:
844 % git checkout -b win32stat
846 Make some changes, build perl and test your changes, then commit them to
847 your local branch. Then push your local branch to a remote smoke-me
850 % git push origin win32stat:smoke-me/tonyc/win32stat
852 Now you can switch back to blead locally:
856 and continue working on other things while you wait a day or two,
857 keeping an eye on the results reported for your smoke-me branch at
858 L<http://perl.develop-help.com/?b=smoke-me/tonyc/win32state>.
860 If all is well then update your blead branch:
864 then checkout your smoke-me branch once more and rebase it on blead:
866 % git rebase blead win32stat
868 Now switch back to blead and merge your smoke-me branch into it:
871 % git merge win32stat
873 As described earlier, if there are many changes on your smoke-me branch
874 then you should prepare a merge commit in which to give an overview of
875 those changes by using the following command instead of the last
878 % git merge win32stat --no-ff --no-commit
880 You should now build perl and test your (merged) changes one last time
881 (ideally run the whole test suite, but failing that at least run the
882 F<t/porting/*.t> tests) before pushing your changes as usual:
884 % git push origin blead
886 Finally, you should then delete the remote smoke-me branch:
888 % git push origin :smoke-me/tonyc/win32stat
890 (which is likely to produce a warning like this, which can be ignored:
892 remote: fatal: ambiguous argument 'refs/heads/smoke-me/tonyc/win32stat': unknown revision or path not in the working tree.
893 remote: Use '--' to separate paths from revisions
895 ) and then delete your local branch:
897 % git branch -d win32stat
899 =head2 A note on camel and dromedary
901 The committers have SSH access to the two servers that serve
902 C<perl5.git.perl.org>. One is C<perl5.git.perl.org> itself (I<camel>),
903 which is the 'master' repository. The second one is
904 C<users.perl5.git.perl.org> (I<dromedary>), which can be used for
905 general testing and development. Dromedary syncs the git tree from
906 camel every few minutes, you should not push there. Both machines also
907 have a full CPAN mirror in /srv/CPAN, please use this. To share files
908 with the general public, dromedary serves your ~/public_html/ as
909 C<http://users.perl5.git.perl.org/~yourlogin/>
911 These hosts have fairly strict firewalls to the outside. Outgoing, only
912 rsync, ssh and git are allowed. For http and ftp, you can use
913 http://webproxy:3128 as proxy. Incoming, the firewall tries to detect
914 attacks and blocks IP addresses with suspicious activity. This
915 sometimes (but very rarely) has false positives and you might get
916 blocked. The quickest way to get unblocked is to notify the admins.
918 These two boxes are owned, hosted, and operated by booking.com. You can
919 reach the sysadmins in #p5p on irc.perl.org or via mail to
920 C<perl5-porters@perl.org>.