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