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