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