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 It is also possible to keep C<origin> as a git remote, and add a new remote for ssh access:
  76
  77   % git remote add camel user@camel:/gitroot/perl.git
  78
  79 This allows you to update your local repository by pulling from C<origin>, which is faster and doesn't require you to authentify, and to push your changes back with the C<camel> remote:
  80
  81   % git fetch camel
  82   % git push camel
  83
  84 The C<fetch> command just updates the C<camel> refs, as the objects themselves should have been fetched when pulling from C<origin>.
  85
  86 =head1 OVERVIEW OF THE REPOSITORY
  87
  88 Once you have changed into the repository directory, you can inspect it.
  89
  90
  91 After a clone the repository will contain a single local branch, which
  92 will be the current branch as well, as indicated by the asterix.
  93
  94   % git branch
  95   * blead
  96
  97 Using the -a switch to branch will also show the remote tracking branches in the
  98 repository:
  99
 100   % git branch -a
 101   * blead
 102     origin/HEAD
 103     origin/blead
 104   ...
 105
 106 The branches that begin with "origin" correspond to the "git remote" that
 107 you cloned from (which is named "origin"). Each branch on the remote will
 108 be exactly tracked by theses branches. You should NEVER do work on these
 109 remote tracking branches. You only ever do work in a local branch. Local
 110 branches can be configured to automerge (on pull) from a designated remote
 111 tracking branch. This is the case with the default branch C<blead> which
 112 will be configured to merge from the remote tracking branch
 113 C<origin/blead>.
 114
 115 You can see recent commits:
 116
 117   % git log
 118
 119 And pull new changes from the repository, and update your local repository
 120 (must be clean first)
 121
 122   % git pull
 123
 124 Assuming we are on the branch C<blead> immediately after a pull, this command
 125 would be more or less equivalent to:
 126
 127   % git fetch
 128   % git merge origin/blead
 129
 130 In fact if you want to update your local repository without touching your working
 131 directory you do:
 132
 133   % git fetch
 134
 135 And if you want to update your remote-tracking branches for all defined remotes
 136 simultaneously you can do
 137
 138   % git remote update
 139
 140 Neither of these last two commands will update your working directory, however
 141 both will update the remote-tracking branches in your repository.
 142
 143 To switch to another branch:
 144
 145   % git checkout origin/maint-5.8-dor
 146
 147 To make a local branch of a remote branch:
 148
 149   % git checkout -b maint-5.10 origin/maint-5.10
 150
 151 To switch back to blead:
 152
 153   % git checkout blead
 154
 155 =head2 FINDING OUT YOUR STATUS
 156
 157 The most common git command you will use will probably be
 158
 159   % git status
 160
 161 This command will produce as output a description of the current state of the
 162 repository, including modified files and unignored untracked files, and in addition
 163 it will show things like what files have been staged for the next commit,
 164 and usually some useful information about how to change things. For instance the
 165 following:
 166
 167   $ git status
 168   # On branch blead
 169   # Your branch is ahead of 'origin/blead' by 1 commit.
 170   #
 171   # Changes to be committed:
 172   #   (use "git reset HEAD <file>..." to unstage)
 173   #
 174   #       modified:   pod/perlrepository.pod
 175   #
 176   # Changed but not updated:
 177   #   (use "git add <file>..." to update what will be committed)
 178   #
 179   #       modified:   pod/perlrepository.pod
 180   #
 181   # Untracked files:
 182   #   (use "git add <file>..." to include in what will be committed)
 183   #
 184   #       deliberate.untracked
 185
 186 This shows that there were changes to this document staged for commit, and
 187 that there were further changes in the working directory not yet staged. It
 188 also shows that there was an untracked file in the working directory, and as
 189 you can see shows how to change all of this. It also shows that there
 190 is one commit on the  working branch C<blead> which has not been pushed to the
 191 C<origin> remote yet. B<NOTE>: that this output is also what you see as a
 192 template if you do not provide a message to C<git commit>.
 193
 194 Assuming we commit all the mentioned changes above:
 195
 196   % git commit -a -m'explain git status and stuff about remotes'
 197   Created commit daf8e63: explain git status and stuff about remotes
 198    1 files changed, 83 insertions(+), 3 deletions(-)
 199
 200 We can re-run git status and see something like this:
 201
 202   % git status
 203   # On branch blead
 204   # Your branch is ahead of 'origin/blead' by 2 commits.
 205   #
 206   # Untracked files:
 207   #   (use "git add <file>..." to include in what will be committed)
 208   #
 209   #       deliberate.untracked
 210   nothing added to commit but untracked files present (use "git add" to track)
 211
 212
 213 When in doubt, before you do anything else, check your status and read it
 214 carefully, many questions are answered directly by the git status output.
 215
 216 =head1 SUBMITTING A PATCH
 217
 218 If you have a patch in mind for Perl, you should first get a copy of
 219 the repository:
 220
 221   % git clone git://perl5.git.perl.org/perl.git perl-git
 222
 223 Then change into the directory:
 224
 225   % cd perl-git
 226
 227 Alternatively, if you already have a Perl repository, you should
 228 ensure that you're on the I<blead> branch, and your repository
 229 is up to date:
 230
 231   % git checkout blead
 232   % git pull
 233
 234 Now that we have everything up to date, we need to create a temporary new
 235 branch for these changes and switch into it:
 236
 237   % git checkout -b orange
 238
 239 which is the short form of
 240
 241   % git branch orange
 242   % git checkout orange
 243
 244 Then make your changes. For example, if Leon Brocard changes his name
 245 to Orange Brocard, we should change his name in the AUTHORS file:
 246
 247   % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
 248
 249 You can see what files are changed:
 250
 251   % git status
 252   # On branch blead
 253   # Changes to be committed:
 254   #   (use "git reset HEAD <file>..." to unstage)
 255   #
 256   #     modified:   AUTHORS
 257   #
 258
 259 And you can see the changes:
 260
 261   % git diff
 262   diff --git a/AUTHORS b/AUTHORS
 263   index 293dd70..722c93e 100644
 264   --- a/AUTHORS
 265   +++ b/AUTHORS
 266   @@ -541,7 +541,7 @@    Lars Hecking                   <lhecking@nmrc.ucc.ie>
 267    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
 268    Leif Huhn                      <leif@hale.dkstat.com>
 269    Len Johnson                    <lenjay@ibm.net>
 270   -Leon Brocard                   <acme@astray.com>
 271   +Orange Brocard                 <acme@astray.com>
 272    Les Peters                     <lpeters@aol.net>
 273    Lesley Binks                   <lesley.binks@gmail.com>
 274    Lincoln D. Stein               <lstein@cshl.org>
 275
 276 Now commit your change locally:
 277
 278   % git add AUTHORS
 279   % git commit -m 'Rename Leon Brocard to Orange Brocard'
 280   Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
 281    1 files changed, 1 insertions(+), 1 deletions(-)
 282
 283 Now you should create a patch file for all your local changes:
 284
 285   % git format-patch origin
 286   0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 287
 288 You should now send an email to perl5-porters@perl.org with a
 289 description of your changes, and attach this patch file as an
 290 attachment.
 291
 292 If you want to delete your temporary branch, you may do so with:
 293
 294   % git checkout blead
 295   % git branch -d orange
 296   error: The branch 'orange' is not an ancestor of your current HEAD.
 297   If you are sure you want to delete it, run 'git branch -D orange'.
 298   % git branch -D orange
 299   Deleted branch orange.
 300
 301 =head1 ACCEPTING A PATCH
 302
 303 If you have received a patch file generated using the above section,
 304 you should try out the patch.
 305
 306 First we need to create a temporary new branch for these changes and
 307 switch into it:
 308
 309   % git checkout -b experimental
 310
 311 Now we should apply the patch:
 312
 313   % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 314   Applying Rename Leon Brocard to Orange Brocard
 315
 316 Now we can inspect the change:
 317
 318   % git log
 319   commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
 320   Author: Leon Brocard <acme@astray.com>
 321   Date:   Fri Dec 19 17:02:59 2008 +0000
 322
 323     Rename Leon Brocard to Orange Brocard
 324   ...
 325
 326   % git diff blead
 327   diff --git a/AUTHORS b/AUTHORS
 328   index 293dd70..722c93e 100644
 329   --- a/AUTHORS
 330   +++ b/AUTHORS
 331   @@ -541,7 +541,7 @@ Lars Hecking                        <lhecking@nmrc.ucc.ie>
 332    Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
 333    Leif Huhn                      <leif@hale.dkstat.com>
 334    Len Johnson                    <lenjay@ibm.net>
 335   -Leon Brocard                   <acme@astray.com>
 336   +Orange Brocard                 <acme@astray.com>
 337    Les Peters                     <lpeters@aol.net>
 338    Lesley Binks                   <lesley.binks@gmail.com>
 339    Lincoln D. Stein               <lstein@cshl.org>
 340
 341 If you are a committer to Perl and you think the patch is good, you can
 342 then merge it into blead then push it out to the main repository:
 343
 344   % git checkout blead
 345   % git merge experimental
 346   % git push
 347
 348 If you want to delete your temporary branch, you may do so with:
 349
 350   % git checkout blead
 351   % git branch -d experimental
 352   error: The branch 'experimental' is not an ancestor of your current HEAD.
 353   If you are sure you want to delete it, run 'git branch -D experimental'.
 354   % git branch -D experimental
 355   Deleted branch experimental.
 356
 357 =head1 CLEANING A WORKING DIRECTORY
 358
 359 The command C<git clean> can with varying arguments be used as a replacement for make-clean.
 360
 361 To reset your working directory to a pristine condition you can do:
 362
 363   git clean -dxf
 364
 365 However, be aware this will delete ALL untracked content. You can use
 366
 367   git clean -Xf
 368
 369 to remove all ignored untracked files, such as build and test byproduct, but leave any
 370 manually created files alone.
 371