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