3 perlrepository - Using the Perl source repository
7 All of Perl's source code is kept centrally in a Git repository. The
8 repository contains many Perl revisions from Perl 1 onwards and all
9 the revisions from Perforce, the version control system we were using
10 previously. This repository is accessible in different ways.
12 The full repository takes up about 80MB of disk space. A check out of
13 blead takes up about 160MB of disk space (including the repository). A
14 build of blead takes up about 200MB (including the repository and the
17 =head1 GETTING ACCESS TO THE REPOSITORY
19 =head2 READ ACCESS VIA THE WEB
21 You may access this over the web. This allows you to browse the tree,
22 see recent commits, search for particular commits and more. You may
25 http://perl5.git.perl.org/perl.git
27 =head2 READ ACCESS VIA GIT
29 You will need a copy of Git for your computer. You can fetch a copy of
30 the repository using the Git protocol (which uses port 9418):
32 git clone git://perl5.git.perl.org/perl.git perl-git
34 This clones the repository and makes a local copy in the 'perl-git'
37 If your local network does not allow you to use port 9418, then you can
38 fetch a copy of the repository over HTTP (this is slower):
40 git clone http://perl5.git.perl.org/perl.git perl-http
42 This clones the repository and makes a local copy in the 'perl-http'
45 =head2 WRITE ACCESS TO THE REPOSITORY
47 If you are a committer, then you can fetch a copy of the repository that
48 you can push back on with:
50 git clone ssh://perl5.git.perl.org/gitroot/perl.git perl-ssh
52 This clones the repository and makes a local copy in the 'perl-ssh'
55 If you clone using git, which is faster than ssh, then you will need to
56 modify your config in order to enable pushing. Edit .git/config where
57 you will see something like:
60 url = git://perl5.git.perl.org/perl.git
62 change that to something like this:
65 url = ssh://perl5.git.perl.org/gitroot/perl.git
67 NOTE: there are symlinks set up so that the /gitroot is actually optional.
69 =head1 OVERVIEW OF THE REPOSITORY
71 Once you have changed into the repository directory, you can inspect it.
73 The repository contains a few branches:
81 You can see recent commits:
85 And pull new changes from the repository:
89 To switch to another branch:
91 % git checkout origin/maint-5.8-dor
93 To switch back to blead:
97 =head1 SUBMITTING A PATCH
99 If you have a patch in mind for Perl, you should first get a copy of
102 % git clone git://perl5.git.perl.org/perl.git perl-git
104 Then change into the directory:
108 Then make your changes. For example, if Leon Brocard changes his name
109 to Orange Brocard, we should change his name in the AUTHORS file:
111 % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
113 You can see what files are changed:
117 # Changes to be committed:
118 # (use "git reset HEAD <file>..." to unstage)
124 And you can see the changes:
127 diff --git a/AUTHORS b/AUTHORS
128 index 293dd70..722c93e 100644
132 Lars Hecking <lhecking@nmrc.ucc.ie>
133 Laszlo Molnar <laszlo.molnar@eth.ericsson.se>
134 Leif Huhn <leif@hale.dkstat.com>
135 Len Johnson <lenjay@ibm.net>
136 -Leon Brocard <acme@astray.com>
137 +Orange Brocard <acme@astray.com>
138 Les Peters <lpeters@aol.net>
139 Lesley Binks <lesley.binks@gmail.com>
140 Lincoln D. Stein <lstein@cshl.org>
142 Now commit your change locally:
145 % git commit -m 'Rename Leon Brocard to Orange Brocard'
146 Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
147 1 files changed, 1 insertions(+), 1 deletions(-)
149 Now you should create a patch file for all your local changes:
151 % git-format-patch origin
152 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
154 You should now send an email to perl5-porters@perl.org with a
155 description of your changes, and attach this patch file as an