This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update ExtUtils::ParseXS to 2.21
[perl5.git] / pod / perlrepository.pod
CommitLineData
0549aefb
LB
1=for comment
2Consistent formatting of this file is achieved with:
3 perl ./Porting/podtidy pod/perlrepository.pod
4
d7dd28b6
LB
5=head1 NAME
6
7perlrepository - Using the Perl source repository
8
9=head1 SYNOPSIS
10
dc3c3040 11All of Perl's source code is kept centrally in a Git repository at
c26da522
LB
12I<perl5.git.perl.org>. The repository contains many Perl revisions from
13Perl 1 onwards and all the revisions from Perforce, the version control
14system we were using previously. This repository is accessible in
15different ways.
d7dd28b6
LB
16
17The full repository takes up about 80MB of disk space. A check out of
7f4ffa9d 18the blead branch (that is, the main development branch, which contains
6a7cbfe8
LB
19bleadperl, the development version of perl 5) takes up about 160MB of
20disk space (including the repository). A build of bleadperl takes up
21about 200MB (including the repository and the check out).
d7dd28b6
LB
22
23=head1 GETTING ACCESS TO THE REPOSITORY
24
25=head2 READ ACCESS VIA THE WEB
26
dc3c3040
GA
27You may access the repository over the web. This allows you to browse
28the tree, see recent commits, subscribe to RSS feeds for the changes,
29search for particular commits and more. You may access it at:
d7dd28b6
LB
30
31 http://perl5.git.perl.org/perl.git
32
dc3c3040
GA
33A mirror of the repository is found at:
34
35 http://github.com/github/perl
36
d7dd28b6
LB
37=head2 READ ACCESS VIA GIT
38
39You will need a copy of Git for your computer. You can fetch a copy of
40the repository using the Git protocol (which uses port 9418):
41
3b8a5fb0 42 git clone git://perl5.git.perl.org/perl.git perl-git
d7dd28b6 43
f755e97d 44This clones the repository and makes a local copy in the F<perl-git>
d7dd28b6
LB
45directory.
46
47If your local network does not allow you to use port 9418, then you can
572f57ba 48fetch a copy of the repository over HTTP (this is slower):
d7dd28b6 49
3b8a5fb0 50 git clone http://perl5.git.perl.org/perl.git perl-http
d7dd28b6 51
f755e97d 52This clones the repository and makes a local copy in the F<perl-http>
d7dd28b6
LB
53directory.
54
55=head2 WRITE ACCESS TO THE REPOSITORY
56
6acba58e
LB
57If you are a committer, then you can fetch a copy of the repository
58that you can push back on with:
d7dd28b6 59
3b8a5fb0 60 git clone ssh://perl5.git.perl.org/gitroot/perl.git perl-ssh
d7dd28b6 61
8f718e95 62This clones the repository and makes a local copy in the F<perl-ssh>
d7dd28b6
LB
63directory.
64
c26da522
LB
65If you cloned using the git protocol, which is faster than ssh, then
66you will need to modify your config in order to enable pushing. Edit
67F<.git/config> where you will see something like:
1a0f15d5
YO
68
69 [remote "origin"]
70 url = git://perl5.git.perl.org/perl.git
71
72change that to something like this:
73
74 [remote "origin"]
75 url = ssh://perl5.git.perl.org/gitroot/perl.git
76
dc3c3040
GA
77NOTE: there are symlinks set up so that the /gitroot is optional and
78since SSH is the default protocol you can actually shorten the "url" to
79C<perl5.git.perl.org:/perl.git>.
d7dd28b6 80
184487f0
NC
81You can also set up your user name and e-mail address. For example
82
83 % git config user.name "Leon Brocard"
84 % git config user.email acme@astray.com
85
6acba58e
LB
86It is also possible to keep C<origin> as a git remote, and add a new
87remote for ssh access:
f6c12373 88
dc3c3040 89 % git remote add camel perl5.git.perl.org:/perl.git
f6c12373 90
6acba58e 91This allows you to update your local repository by pulling from
f755e97d 92C<origin>, which is faster and doesn't require you to authenticate, and
6acba58e 93to push your changes back with the C<camel> remote:
f6c12373
VP
94
95 % git fetch camel
96 % git push camel
97
6acba58e
LB
98The C<fetch> command just updates the C<camel> refs, as the objects
99themselves should have been fetched when pulling from C<origin>.
f6c12373 100
6a7cbfe8
LB
101The committers have access to 2 servers that serve perl5.git.perl.org.
102One is camel.booking.com, which is the 'master' repository. The
103perl5.git.perl.org IP address also lives on this machine. The second
104one is dromedary.booking.com, which can be used for general testing and
105development. Dromedary syncs the git tree from camel every few minutes,
106you should not push there. Both machines also have a full CPAN mirror.
107To share files with the general public, dromedary serves your
108~/public_html/ as http://users.perl5.git.perl.org/~yourlogin/
b47aa495 109
d7dd28b6
LB
110=head1 OVERVIEW OF THE REPOSITORY
111
6acba58e
LB
112Once you have changed into the repository directory, you can inspect
113it.
d7dd28b6 114
39219fd3 115After a clone the repository will contain a single local branch, which
50eca761 116will be the current branch as well, as indicated by the asterisk.
39219fd3
YO
117
118 % git branch
119 * blead
120
f755e97d 121Using the -a switch to C<branch> will also show the remote tracking
6acba58e 122branches in the repository:
39219fd3 123
d9847473 124 % git branch -a
09081495 125 * blead
d7dd28b6
LB
126 origin/HEAD
127 origin/blead
128 ...
129
6acba58e
LB
130The branches that begin with "origin" correspond to the "git remote"
131that you cloned from (which is named "origin"). Each branch on the
132remote will be exactly tracked by theses branches. You should NEVER do
133work on these remote tracking branches. You only ever do work in a
134local branch. Local branches can be configured to automerge (on pull)
135from a designated remote tracking branch. This is the case with the
136default branch C<blead> which will be configured to merge from the
137remote tracking branch C<origin/blead>.
39219fd3 138
d7dd28b6
LB
139You can see recent commits:
140
c2cf2042 141 % git log
d7dd28b6 142
6acba58e
LB
143And pull new changes from the repository, and update your local
144repository (must be clean first)
d7dd28b6
LB
145
146 % git pull
09081495 147
6acba58e
LB
148Assuming we are on the branch C<blead> immediately after a pull, this
149command would be more or less equivalent to:
39219fd3
YO
150
151 % git fetch
152 % git merge origin/blead
153
6acba58e
LB
154In fact if you want to update your local repository without touching
155your working directory you do:
39219fd3
YO
156
157 % git fetch
158
6acba58e
LB
159And if you want to update your remote-tracking branches for all defined
160remotes simultaneously you can do
39219fd3
YO
161
162 % git remote update
163
6acba58e
LB
164Neither of these last two commands will update your working directory,
165however both will update the remote-tracking branches in your
166repository.
39219fd3 167
09081495
LB
168To switch to another branch:
169
170 % git checkout origin/maint-5.8-dor
171
6051489b
NC
172To make a local branch of a remote branch:
173
174 % git checkout -b maint-5.10 origin/maint-5.10
175
09081495
LB
176To switch back to blead:
177
178 % git checkout blead
c2cf2042 179
39219fd3
YO
180=head2 FINDING OUT YOUR STATUS
181
182The most common git command you will use will probably be
183
184 % git status
185
6acba58e
LB
186This command will produce as output a description of the current state
187of the repository, including modified files and unignored untracked
188files, and in addition it will show things like what files have been
189staged for the next commit, and usually some useful information about
190how to change things. For instance the following:
39219fd3
YO
191
192 $ git status
193 # On branch blead
194 # Your branch is ahead of 'origin/blead' by 1 commit.
195 #
196 # Changes to be committed:
197 # (use "git reset HEAD <file>..." to unstage)
198 #
199 # modified: pod/perlrepository.pod
200 #
201 # Changed but not updated:
202 # (use "git add <file>..." to update what will be committed)
203 #
204 # modified: pod/perlrepository.pod
205 #
206 # Untracked files:
207 # (use "git add <file>..." to include in what will be committed)
208 #
209 # deliberate.untracked
210
6acba58e
LB
211This shows that there were changes to this document staged for commit,
212and that there were further changes in the working directory not yet
213staged. It also shows that there was an untracked file in the working
214directory, and as you can see shows how to change all of this. It also
0549aefb
LB
215shows that there is one commit on the working branch C<blead> which has
216not been pushed to the C<origin> remote yet. B<NOTE>: that this output
217is also what you see as a template if you do not provide a message to
218C<git commit>.
7f6effc7
YO
219
220Assuming we commit all the mentioned changes above:
221
222 % git commit -a -m'explain git status and stuff about remotes'
223 Created commit daf8e63: explain git status and stuff about remotes
224 1 files changed, 83 insertions(+), 3 deletions(-)
225
226We can re-run git status and see something like this:
227
228 % git status
229 # On branch blead
230 # Your branch is ahead of 'origin/blead' by 2 commits.
231 #
232 # Untracked files:
233 # (use "git add <file>..." to include in what will be committed)
234 #
235 # deliberate.untracked
236 nothing added to commit but untracked files present (use "git add" to track)
237
39219fd3 238
6acba58e
LB
239When in doubt, before you do anything else, check your status and read
240it carefully, many questions are answered directly by the git status
241output.
39219fd3 242
c2cf2042
LB
243=head1 SUBMITTING A PATCH
244
245If you have a patch in mind for Perl, you should first get a copy of
246the repository:
247
248 % git clone git://perl5.git.perl.org/perl.git perl-git
249
250Then change into the directory:
251
252 % cd perl-git
253
6acba58e
LB
254Alternatively, if you already have a Perl repository, you should ensure
255that you're on the I<blead> branch, and your repository is up to date:
12322d22
A
256
257 % git checkout blead
258 % git pull
259
6a7cbfe8
LB
260It's preferable to patch against the latest blead version, since this
261is where new development occurs for all changes other than critical bug
262fixes. Critical bug fix patches should be made against the relevant
7f4ffa9d
RS
263maint branches, or should be submitted with a note indicating all the
264branches where the fix should be applied.
a44f43ac 265
6acba58e
LB
266Now that we have everything up to date, we need to create a temporary
267new branch for these changes and switch into it:
b1fccde5 268
a9b05323 269 % git checkout -b orange
23f8d33e 270
a9b05323
YO
271which is the short form of
272
b1fccde5
LB
273 % git branch orange
274 % git checkout orange
275
c2cf2042
LB
276Then make your changes. For example, if Leon Brocard changes his name
277to Orange Brocard, we should change his name in the AUTHORS file:
278
279 % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
280
281You can see what files are changed:
282
283 % git status
f755e97d 284 # On branch orange
c2cf2042
LB
285 # Changes to be committed:
286 # (use "git reset HEAD <file>..." to unstage)
287 #
288 # modified: AUTHORS
289 #
290
c2cf2042
LB
291And you can see the changes:
292
293 % git diff
294 diff --git a/AUTHORS b/AUTHORS
295 index 293dd70..722c93e 100644
296 --- a/AUTHORS
297 +++ b/AUTHORS
7df2e4bc 298 @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie>
c2cf2042
LB
299 Laszlo Molnar <laszlo.molnar@eth.ericsson.se>
300 Leif Huhn <leif@hale.dkstat.com>
301 Len Johnson <lenjay@ibm.net>
302 -Leon Brocard <acme@astray.com>
303 +Orange Brocard <acme@astray.com>
304 Les Peters <lpeters@aol.net>
305 Lesley Binks <lesley.binks@gmail.com>
306 Lincoln D. Stein <lstein@cshl.org>
307
308Now commit your change locally:
309
dc3c3040 310 % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
c2cf2042
LB
311 Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
312 1 files changed, 1 insertions(+), 1 deletions(-)
313
dc3c3040
GA
314You can examine your last commit with:
315
316 % git show HEAD
317
318and if you are not happy with either the description or the patch
c26da522 319itself you can fix it up by editing the files once more and then issue:
dc3c3040
GA
320
321 % git commit -a --amend
322
c2cf2042
LB
323Now you should create a patch file for all your local changes:
324
2af192ee 325 % git format-patch origin
c2cf2042
LB
326 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
327
328You should now send an email to perl5-porters@perl.org with a
dc3c3040 329description of your changes, and include this patch file as an
c2cf2042
LB
330attachment.
331
b1fccde5
LB
332If you want to delete your temporary branch, you may do so with:
333
334 % git checkout blead
335 % git branch -d orange
336 error: The branch 'orange' is not an ancestor of your current HEAD.
337 If you are sure you want to delete it, run 'git branch -D orange'.
338 % git branch -D orange
339 Deleted branch orange.
7df2e4bc 340
a44f43ac
RGS
341=head2 A note on derived files
342
343Be aware that many files in the distribution are derivative--avoid
0549aefb
LB
344patching them, because git won't see the changes to them, and the build
345process will overwrite them. Patch the originals instead. Most
346utilities (like perldoc) are in this category, i.e. patch
347utils/perldoc.PL rather than utils/perldoc. Similarly, don't create
348patches for files under $src_root/ext from their copies found in
349$install_root/lib. If you are unsure about the proper location of a
350file that may have gotten copied while building the source
351distribution, consult the C<MANIFEST>.
a44f43ac 352
6e2cec71 353=for XXX
a44f43ac 354
6e2cec71 355What should we recommend about binary files now? Do we need anything?
a44f43ac
RGS
356
357=head2 Getting your patch accepted
358
0549aefb
LB
359The first thing you should include with your patch is a description of
360the problem that the patch corrects. If it is a code patch (rather
361than a documentation patch) you should also include a small test case
362that illustrates the bug (a patch to an existing test file is
363preferred).
a44f43ac
RGS
364
365If you are submitting a code patch there are several other things that
366you need to do.
367
368=over 4
369
370=item Comments, Comments, Comments
371
0549aefb
LB
372Be sure to adequately comment your code. While commenting every line
373is unnecessary, anything that takes advantage of side effects of
a44f43ac 374operators, that creates changes that will be felt outside of the
0549aefb
LB
375function being patched, or that others may find confusing should be
376documented. If you are going to err, it is better to err on the side
377of adding too many comments than too few.
a44f43ac
RGS
378
379=item Style
380
0549aefb
LB
381In general, please follow the particular style of the code you are
382patching.
a44f43ac 383
0549aefb
LB
384In particular, follow these general guidelines for patching Perl
385sources:
a44f43ac
RGS
386
387 8-wide tabs (no exceptions!)
388 4-wide indents for code, 2-wide indents for nested CPP #defines
389 try hard not to exceed 79-columns
390 ANSI C prototypes
391 uncuddled elses and "K&R" style for indenting control constructs
392 no C++ style (//) comments
393 mark places that need to be revisited with XXX (and revisit often!)
394 opening brace lines up with "if" when conditional spans multiple
395 lines; should be at end-of-line otherwise
396 in function definitions, name starts in column 0 (return value is on
397 previous line)
398 single space after keywords that are followed by parens, no space
399 between function name and following paren
400 avoid assignments in conditionals, but if they're unavoidable, use
401 extra paren, e.g. "if (a && (b = c)) ..."
402 "return foo;" rather than "return(foo);"
403 "if (!foo) ..." rather than "if (foo == FALSE) ..." etc.
404
405=item Testsuite
406
0549aefb
LB
407When submitting a patch you should make every effort to also include an
408addition to perl's regression tests to properly exercise your patch.
409Your testsuite additions should generally follow these guidelines
410(courtesy of Gurusamy Sarathy <gsar@activestate.com>):
a44f43ac
RGS
411
412 Know what you're testing. Read the docs, and the source.
413 Tend to fail, not succeed.
414 Interpret results strictly.
415 Use unrelated features (this will flush out bizarre interactions).
416 Use non-standard idioms (otherwise you are not testing TIMTOWTDI).
417 Avoid using hardcoded test numbers whenever possible (the
418 EXPECTED/GOT found in t/op/tie.t is much more maintainable,
419 and gives better failure reports).
420 Give meaningful error messages when a test fails.
421 Avoid using qx// and system() unless you are testing for them. If you
422 do use them, make sure that you cover _all_ perl platforms.
423 Unlink any temporary files you create.
424 Promote unforeseen warnings to errors with $SIG{__WARN__}.
425 Be sure to use the libraries and modules shipped with the version
426 being tested, not those that were already installed.
427 Add comments to the code explaining what you are testing for.
428 Make updating the '1..42' string unnecessary. Or make sure that
429 you update it.
430 Test _all_ behaviors of a given operator, library, or function:
431 - All optional arguments
432 - Return values in various contexts (boolean, scalar, list, lvalue)
433 - Use both global and lexical variables
434 - Don't forget the exceptional, pathological cases.
435
436=back
437
7df2e4bc
LB
438=head1 ACCEPTING A PATCH
439
440If you have received a patch file generated using the above section,
441you should try out the patch.
442
443First we need to create a temporary new branch for these changes and
444switch into it:
445
a9b05323 446 % git checkout -b experimental
7df2e4bc 447
6acba58e
LB
448Patches that were formatted by C<git format-patch> are applied with
449C<git am>:
7df2e4bc 450
2af192ee 451 % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
7df2e4bc
LB
452 Applying Rename Leon Brocard to Orange Brocard
453
6acba58e
LB
454If just a raw diff is provided, it is also possible use this two-step
455process:
09645c26
VP
456
457 % git apply bugfix.diff
dc3c3040 458 % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>"
09645c26 459
7df2e4bc
LB
460Now we can inspect the change:
461
dc3c3040 462 % git show HEAD
7df2e4bc
LB
463 commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
464 Author: Leon Brocard <acme@astray.com>
465 Date: Fri Dec 19 17:02:59 2008 +0000
466
467 Rename Leon Brocard to Orange Brocard
7df2e4bc 468
7df2e4bc
LB
469 diff --git a/AUTHORS b/AUTHORS
470 index 293dd70..722c93e 100644
471 --- a/AUTHORS
472 +++ b/AUTHORS
473 @@ -541,7 +541,7 @@ Lars Hecking <lhecking@nmrc.ucc.ie>
474 Laszlo Molnar <laszlo.molnar@eth.ericsson.se>
475 Leif Huhn <leif@hale.dkstat.com>
476 Len Johnson <lenjay@ibm.net>
477 -Leon Brocard <acme@astray.com>
478 +Orange Brocard <acme@astray.com>
479 Les Peters <lpeters@aol.net>
480 Lesley Binks <lesley.binks@gmail.com>
481 Lincoln D. Stein <lstein@cshl.org>
482
483If you are a committer to Perl and you think the patch is good, you can
75fb7651 484then merge it into blead then push it out to the main repository:
7df2e4bc
LB
485
486 % git checkout blead
d9847473 487 % git merge experimental
75fb7651 488 % git push
7df2e4bc
LB
489
490If you want to delete your temporary branch, you may do so with:
491
492 % git checkout blead
493 % git branch -d experimental
494 error: The branch 'experimental' is not an ancestor of your current HEAD.
495 If you are sure you want to delete it, run 'git branch -D experimental'.
496 % git branch -D experimental
497 Deleted branch experimental.
b0d36535
YO
498
499=head1 CLEANING A WORKING DIRECTORY
500
6acba58e 501The command C<git clean> can with varying arguments be used as a
dc3c3040 502replacement for C<make clean>.
b0d36535
YO
503
504To reset your working directory to a pristine condition you can do:
505
506 git clean -dxf
507
508However, be aware this will delete ALL untracked content. You can use
509
510 git clean -Xf
511
6acba58e
LB
512to remove all ignored untracked files, such as build and test
513byproduct, but leave any manually created files alone.
b0d36535 514
0549aefb 515If you only want to cancel some uncommitted edits, you can use C<git
c26da522
LB
516checkout> and give it a list of files to be reverted, or C<git checkout
517-f> to revert them all.
f755e97d
RGS
518
519If you want to cancel one or several commits, you can use C<git reset>.
520
d82a90c1
VP
521=head1 BISECTING
522
6acba58e
LB
523C<git> provides a built-in way to determine, with a binary search in
524the history, which commit should be blamed for introducing a given bug.
d82a90c1 525
6acba58e
LB
526Suppose that we have a script F<~/testcase.pl> that exits with C<0>
527when some behaviour is correct, and with C<1> when it's faulty. We need
528an helper script that automates building C<perl> and running the
529testcase:
d82a90c1
VP
530
531 % cat ~/run
532 #!/bin/sh
533 git clean -dxf
534 # If you can use ccache, add -Dcc=ccache\ gcc -Dld=gcc to the Configure line
c0d1ef72
MB
535 sh Configure -des -Dusedevel -Doptimize="-g"
536 test -f config.sh || exit 125
537 # Correct makefile for newer GNU gcc
538 perl -ni -we 'print unless /<(?:built-in|command)/' makefile x2p/makefile
539 # if you just need miniperl, replace test_prep with miniperl
540 make -j4 test_prep
541 -x ./perl || exit 125
d82a90c1 542 ./perl -Ilib ~/testcase.pl
c0d1ef72
MB
543 ret=$?
544 git clean -dxf
545 exit $ret
d82a90c1 546
6acba58e
LB
547This script may return C<125> to indicate that the corresponding commit
548should be skipped. Otherwise, it returns the status of
549F<~/testcase.pl>.
d82a90c1
VP
550
551We first enter in bisect mode with:
552
553 % git bisect start
554
6acba58e
LB
555For example, if the bug is present on C<HEAD> but wasn't in 5.10.0,
556C<git> will learn about this when you enter:
d82a90c1
VP
557
558 % git bisect bad
559 % git bisect good perl-5.10.0
560 Bisecting: 853 revisions left to test after this
561
6acba58e
LB
562This results in checking out the median commit between C<HEAD> and
563C<perl-5.10.0>. We can then run the bisecting process with:
d82a90c1
VP
564
565 % git bisect run ~/run
566
567When the first bad commit is isolated, C<git bisect> will tell you so:
568
569 ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit
570 commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5
571 Author: Dave Mitchell <davem@fdisolutions.com>
572 Date: Sat Feb 9 14:56:23 2008 +0000
573
9469eb4a 574 [perl #49472] Attributes + Unknown Error
d82a90c1
VP
575 ...
576
577 bisect run success
578
6acba58e
LB
579You can peek into the bisecting process with C<git bisect log> and
580C<git bisect visualize>. C<git bisect reset> will get you out of bisect
581mode.
d82a90c1 582
6acba58e
LB
583Please note that the first C<good> state must be an ancestor of the
584first C<bad> state. If you want to search for the commit that I<solved>
585some bug, you have to negate your test case (i.e. exit with C<1> if OK
586and C<0> if not) and still mark the lower bound as C<good> and the
587upper as C<bad>. The "first bad commit" has then to be understood as
588the "first commit where the bug is solved".
d82a90c1 589
6acba58e
LB
590C<git help bisect> has much more information on how you can tweak your
591binary searches.
9d68b7ed 592
03050721
LB
593=head1 SUBMITTING A PATCH VIA GITHUB
594
595GitHub is a website that makes it easy to fork and publish projects
596with Git. First you should set up a GitHub account and log in.
597
598Perl's git repository is mirrored on GitHub at this page:
599
600 http://github.com/github/perl/tree/blead
601
602Visit the page and click the "fork" button. This clones the Perl git
603repository for you and provides you with "Your Clone URL" from which
604you should clone:
605
606 % git clone git@github.com:USERNAME/perl.git perl-github
607
608We shall make the same patch as above, creating a new branch:
609
610 % cd perl-github
611 % git remote add upstream git://github.com/github/perl.git
612 % git pull upstream blead
613 % git checkout -b orange
614 % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
dc3c3040 615 % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
03050721
LB
616 % git push origin orange
617
618The orange branch has been pushed to GitHub, so you should now send an
619email to perl5-porters@perl.org with a description of your changes and
620the following information:
621
622 http://github.com/USERNAME/perl/tree/orange
623 git@github.com:USERNAME/perl.git branch orange
624
c26da522
LB
625=head1 MERGING FROM A BRANCH VIA GITHUB
626
627If someone has provided a branch via GitHub and you are a committer,
5c9c28c6 628you should use the following in your perl-ssh directory:
c26da522
LB
629
630 % git remote add dandv git://github.com/dandv/perl.git
631 % git fetch
632
633Now you can see the differences between the branch and blead:
634
635 % git diff dandv/blead
636
637And you can see the commits:
638
639 % git log dandv/blead
640
641If you approve of a specific commit, you can cherry pick it:
642
2bab0636
LB
643 % git cherry-pick 3adac458cb1c1d41af47fc66e67b49c8dec2323f
644
645Or you could just merge the whole branch if you like it all:
646
647 % git merge dandv/blead
c26da522
LB
648
649And then push back to the repository:
650
651 % git push
652
9469eb4a 653=head1 COMMITTING TO MAINTENANCE VERSIONS
9d68b7ed 654
7f4ffa9d
RS
655Maintenance versions should only be altered to add critical bug fixes.
656
9d68b7ed
LB
657To commit to a maintenance version of perl, you need to create a local
658tracking branch:
659
660 % git checkout --track -b maint-5.005 origin/maint-5.005
661
0549aefb
LB
662This creates a local branch named C<maint-5.005>, which tracks the
663remote branch C<origin/maint-5.005>. Then you can pull, commit, merge
664and push as before.
b0d36535 665
f755e97d 666You can also cherry-pick commits from blead and another branch, by
0549aefb
LB
667using the C<git cherry-pick> command. It is recommended to use the
668B<-x> option to C<git cherry-pick> in order to record the SHA1 of the
669original commit in the new commit message.
f755e97d
RGS
670
671=head1 SEE ALSO
672
673The git documentation, accessible via C<git help command>.
0549aefb 674