pod/perlrepository.pod

   1 =head1 NAME
   2
   3 perlrepository - Using the Perl source repository
   4
   5 =head1 SYNOPSIS
   6
   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.
  11
  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
  15 check out).
  16
  17 =head1 GETTING ACCESS TO THE REPOSITORY
  18
  19 =head2 READ ACCESS VIA THE WEB
  20
  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
  23 access it at:
  24
  25   http://perl5.git.perl.org/perl.git
  26
  27 =head2 READ ACCESS VIA GIT
  28
  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):
  31
  32   git clone git://perl5.git.perl.org/perl.git perl-git
  33
  34 This clones the repository and makes a local copy in the 'perl-git'
  35 directory.
  36
  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):
  39
  40   git clone http://perl5.git.perl.org/perl.git perl-http
  41
  42 This clones the repository and makes a local copy in the 'perl-http'
  43 directory.
  44
  45 =head2 WRITE ACCESS TO THE REPOSITORY
  46
  47 If you are a committer, then you can fetch a copy of the repository that
  48 you can push back on with:
  49
  50   git clone ssh://perl5.git.perl.org/gitroot/perl.git perl-ssh
  51
  52 This clones the repository and makes a local copy in the 'perl-ssh'
  53 directory.
  54
  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:
  58
  59   [remote "origin"]
  60   url = git://perl5.git.perl.org/perl.git
  61
  62 change that to something like this:
  63
  64   [remote "origin"]
  65   url = ssh://perl5.git.perl.org/gitroot/perl.git
  66
  67 NOTE: there are symlinks set up so that the /gitroot is actually optional.
  68
  69 =head1 OVERVIEW OF THE REPOSITORY
  70
  71 Once you have changed into the repository directory, you can inspect it.
  72
  73 The repository contains a few branches:
  74
  75   % git branch -a
  76   * blead
  77     origin/HEAD
  78     origin/blead
  79   ...
  80
  81 You can see recent commits:
  82
  83   % git log
  84
  85 And pull new changes from the repository:
  86
  87   % git pull
  88
  89 To switch to another branch:
  90
  91   % git checkout origin/maint-5.8-dor
  92
  93 To switch back to blead:
  94
  95   % git checkout blead
  96
  97 =head1 SUBMITTING A PATCH
  98
  99 If you have a patch in mind for Perl, you should first get a copy of
 100 the repository:
 101
 102   % git clone git://perl5.git.perl.org/perl.git perl-git
 103
 104 Then change into the directory:
 105
 106   % cd perl-git
 107
 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:
 110
 111   % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
 112
 113 You can see what files are changed:
 114
 115   % git status
 116   # On branch blead
 117   # Changes to be committed:
 118   #   (use "git reset HEAD <file>..." to unstage)
 119   #
 120   #     modified:   AUTHORS
 121   #
 122
 123
 124 And you can see the changes:
 125
 126   % git diff
 127   diff --git a/AUTHORS b/AUTHORS
 128   index 293dd70..722c93e 100644
 129   --- a/AUTHORS
 130   +++ b/AUTHORS
 131   @@ -541,7 +541,7 @@
 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>
 141
 142 Now commit your change locally:
 143
 144   % git add AUTHORS
 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(-)
 148
 149 Now you should create a patch file for all your local changes:
 150
 151   % git-format-patch origin
 152   0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 153
 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
 156 attachment.
 157