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 the blead branch (that is, the master branch, which contains bleadperl,
  14 the development version of perl 5) takes up about 160MB of disk space
  15 (including the repository). A build of bleadperl takes up about 200MB
  16 (including the repository and the check out).
  17
  18 =head1 GETTING ACCESS TO THE REPOSITORY
  19
  20 =head2 READ ACCESS VIA THE WEB
  21
  22 You may access this over the web. This allows you to browse the tree,
  23 see recent commits, search for particular commits and more. You may
  24 access it at:
  25
  26   http://perl5.git.perl.org/perl.git
  27
  28 =head2 READ ACCESS VIA GIT
  29
  30 You will need a copy of Git for your computer. You can fetch a copy of
  31 the repository using the Git protocol (which uses port 9418):
  32
  33   git clone git://perl5.git.perl.org/perl.git perl-git
  34
  35 This clones the repository and makes a local copy in the 'perl-git'
  36 directory.
  37
  38 If your local network does not allow you to use port 9418, then you can
  39 fetch a copy of the repository over HTTP (this is slower):
  40
  41   git clone http://perl5.git.perl.org/perl.git perl-http
  42
  43 This clones the repository and makes a local copy in the 'perl-http'
  44 directory.
  45
  46 =head2 WRITE ACCESS TO THE REPOSITORY
  47
  48 If you are a committer, then you can fetch a copy of the repository that
  49 you can push back on with:
  50
  51   git clone ssh://perl5.git.perl.org/gitroot/perl.git perl-ssh
  52
  53 This clones the repository and makes a local copy in the 'perl-ssh'
  54 directory.
  55
  56 If you clone using git, which is faster than ssh, then you will need to
  57 modify your config in order to enable pushing. Edit F<.git/config> where
  58 you will see something like:
  59
  60   [remote "origin"]
  61   url = git://perl5.git.perl.org/perl.git
  62
  63 change that to something like this:
  64
  65   [remote "origin"]
  66   url = ssh://perl5.git.perl.org/gitroot/perl.git
  67
  68 NOTE: there are symlinks set up so that the /gitroot is actually optional.
  69
  70 You can also set up your user name and e-mail address. For example
  71
  72   % git config user.name "Leon Brocard"
  73   % git config user.email acme@astray.com
  74
  75 =head1 OVERVIEW OF THE REPOSITORY
  76
  77 Once you have changed into the repository directory, you can inspect it.
  78
  79
  80 After a clone the repository will contain a single local branch, which
  81 will be the current branch as well, as indicated by the asterix.
  82
  83   % git branch
  84   * blead
  85
  86 Using the -a switch to branch will also show the remote tracking branches in the
  87 repository:
  88
  89   % git branch -a
  90   * blead
  91     origin/HEAD
  92     origin/blead
  93   ...
  94
  95 The branches that begin with "origin" correspond to the "git remote" that
  96 you cloned from (which is named "origin"). Each branch on the remote will
  97 be exactly tracked by theses branches. You should NEVER do work on these
  98 remote tracking branches. You only ever do work in a local branch. Local
  99 branches can be configured to automerge (on pull) from a designated remote
 100 tracking branch. This is the case with the default branch C<blead> which
 101 will be configured to merge from the remote tracking branch
 102 C<origin/blead>.
 103
 104 You can see recent commits:
 105
 106   % git log
 107
 108 And pull new changes from the repository, and update your local repository
 109 (must be clean first)
 110
 111   % git pull
 112
 113 Assuming we are on the branch C<blead> immediately after a pull, this command
 114 would be more or less equivalent to:
 115
 116   % git fetch
 117   % git merge origin/blead
 118
 119 In fact if you want to update your local repository without touching your working
 120 directory you do:
 121
 122   % git fetch
 123
 124 And if you want to update your remote-tracking branches for all defined remotes
 125 simultaneously you can do
 126
 127   % git remote update
 128
 129 Neither of these last two commands will update your working directory, however
 130 both will update the remote-tracking branches in your repository.
 131
 132 To switch to another branch:
 133
 134   % git checkout origin/maint-5.8-dor
 135
 136 To make a local branch of a remote branch:
 137
 138   % git checkout -b maint-5.10 origin/maint-5.10
 139
 140 To switch back to blead:
 141
 142   % git checkout blead
 143
 144 =head2 FINDING OUT YOUR STATUS
 145
 146 The most common git command you will use will probably be
 147
 148   % git status
 149
 150 This command will produce as output a description of the current state of the
 151 repository, including modified files and unignored untracked files, and in addition
 152 it will show things like what files have been staged for the next commit,
 153 and usually some useful information about how to change things. For instance the
 154 following:
 155
 156   $ git status
 157   # On branch blead
 158   # Your branch is ahead of 'origin/blead' by 1 commit.
 159   #
 160   # Changes to be committed:
 161   #   (use "git reset HEAD <file>..." to unstage)
 162   #
 163   #       modified:   pod/perlrepository.pod
 164   #
 165   # Changed but not updated:
 166   #   (use "git add <file>..." to update what will be committed)
 167   #
 168   #       modified:   pod/perlrepository.pod
 169   #
 170   # Untracked files:
 171   #   (use "git add <file>..." to include in what will be committed)
 172   #
 173   #       deliberate.untracked
 174
 175 This shows that there were changes to this document staged for commit, and
 176 that there were further changes in the working directory not yet staged. It
 177 also shows that there was an untracked file in the working directory, and as
 178 you can see shows how to change all of this. It also shows that there
 179 is one commit on the  working branch C<blead> which has not been pushed to the
 180 C<origin> remote yet. B<NOTE>: that this output is also what you see as a
 181 template if you do not provide a message to C<git commit>.
 182
 183 Assuming we commit all the mentioned changes above:
 184
 185   % git commit -a -m'explain git status and stuff about remotes'
 186   Created commit daf8e63: explain git status and stuff about remotes
 187    1 files changed, 83 insertions(+), 3 deletions(-)
 188
 189 We can re-run git status and see something like this:
 190
 191   % git status
 192   # On branch blead
 193   # Your branch is ahead of 'origin/blead' by 2 commits.
 194   #
 195   # Untracked files:
 196   #   (use "git add <file>..." to include in what will be committed)
 197   #
 198   #       deliberate.untracked
 199   nothing added to commit but untracked files present (use "git add" to track)
 200
 201
 202 When in doubt, before you do anything else, check your status and read it
 203 carefully, many questions are answered directly by the git status output.
 204
 205 =head1 SUBMITTING A PATCH
 206
 207 If you have a patch in mind for Perl, you should first get a copy of
 208 the repository:
 209
 210   % git clone git://perl5.git.perl.org/perl.git perl-git
 211
 212 Then change into the directory:
 213
 214   % cd perl-git
 215
 216 Alternatively, if you already have a Perl repository, you should
 217 ensure that you're on the I<blead> branch, and your repository
 218 is up to date:
 219
 220   % git checkout blead
 221   % git pull
 222
 223 Now that we have everything up to date, we need to create a temporary new
 224 branch for these changes and switch into it:
 225
 226   % git checkout -b orange
 227
 228 which is the short form of
 229
 230   % git branch orange
 231   % git checkout orange
 232
 233 Then make your changes. For example, if Leon Brocard changes his name
 234 to Orange Brocard, we should change his name in the AUTHORS file:
 235
 236   % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
 237
 238 You can see what files are changed:
 239
 240   % git status
 241   # On branch blead
 242   # Changes to be committed:
 243   #   (use "git reset HEAD <file>..." to unstage)
 244   #
 245   #     modified:   AUTHORS
 246   #
 247
 248 And you can see the changes:
 249
 250   % git diff
 251   diff --git a/AUTHORS b/AUTHORS
 252   index 293dd70..722c93e 100644
 253   --- a/AUTHORS
 254   +++ b/AUTHORS
 255   @@ -541,7 +541,7 @@    Lars Hecking                   <lhecking@nmrc.ucc.ie>
 256    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
 257    Leif Huhn                      <leif@hale.dkstat.com>
 258    Len Johnson                    <lenjay@ibm.net>
 259   -Leon Brocard                   <acme@astray.com>
 260   +Orange Brocard                 <acme@astray.com>
 261    Les Peters                     <lpeters@aol.net>
 262    Lesley Binks                   <lesley.binks@gmail.com>
 263    Lincoln D. Stein               <lstein@cshl.org>
 264
 265 Now commit your change locally:
 266
 267   % git add AUTHORS
 268   % git commit -m 'Rename Leon Brocard to Orange Brocard'
 269   Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
 270    1 files changed, 1 insertions(+), 1 deletions(-)
 271
 272 Now you should create a patch file for all your local changes:
 273
 274   % git format-patch origin
 275   0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 276
 277 You should now send an email to perl5-porters@perl.org with a
 278 description of your changes, and attach this patch file as an
 279 attachment.
 280
 281 If you want to delete your temporary branch, you may do so with:
 282
 283   % git checkout blead
 284   % git branch -d orange
 285   error: The branch 'orange' is not an ancestor of your current HEAD.
 286   If you are sure you want to delete it, run 'git branch -D orange'.
 287   % git branch -D orange
 288   Deleted branch orange.
 289
 290 =head1 ACCEPTING A PATCH
 291
 292 If you have received a patch file generated using the above section,
 293 you should try out the patch.
 294
 295 First we need to create a temporary new branch for these changes and
 296 switch into it:
 297
 298   % git checkout -b experimental
 299
 300 Now we should apply the patch:
 301
 302   % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 303   Applying Rename Leon Brocard to Orange Brocard
 304
 305 Now we can inspect the change:
 306
 307   % git log
 308   commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
 309   Author: Leon Brocard <acme@astray.com>
 310   Date:   Fri Dec 19 17:02:59 2008 +0000
 311
 312     Rename Leon Brocard to Orange Brocard
 313   ...
 314
 315   % git diff blead
 316   diff --git a/AUTHORS b/AUTHORS
 317   index 293dd70..722c93e 100644
 318   --- a/AUTHORS
 319   +++ b/AUTHORS
 320   @@ -541,7 +541,7 @@ Lars Hecking                        <lhecking@nmrc.ucc.ie>
 321    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
 322    Leif Huhn                      <leif@hale.dkstat.com>
 323    Len Johnson                    <lenjay@ibm.net>
 324   -Leon Brocard                   <acme@astray.com>
 325   +Orange Brocard                 <acme@astray.com>
 326    Les Peters                     <lpeters@aol.net>
 327    Lesley Binks                   <lesley.binks@gmail.com>
 328    Lincoln D. Stein               <lstein@cshl.org>
 329
 330 If you are a committer to Perl and you think the patch is good, you can
 331 then merge it into blead then push it out to the main repository:
 332
 333   % git checkout blead
 334   % git merge experimental
 335   % git push
 336
 337 If you want to delete your temporary branch, you may do so with:
 338
 339   % git checkout blead
 340   % git branch -d experimental
 341   error: The branch 'experimental' is not an ancestor of your current HEAD.
 342   If you are sure you want to delete it, run 'git branch -D experimental'.
 343   % git branch -D experimental
 344   Deleted branch experimental.