This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Various corrections and formatting nits to perlrepository.pod
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Sat, 20 Dec 2008 14:41:14 +0000 (15:41 +0100)
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Sat, 20 Dec 2008 14:41:14 +0000 (15:41 +0100)
pod/perlrepository.pod

index d790099..e83f0a7 100644 (file)
@@ -10,9 +10,10 @@ the revisions from Perforce, the version control system we were using
 previously. This repository is accessible in different ways.
 
 The full repository takes up about 80MB of disk space. A check out of
-blead takes up about 160MB of disk space (including the repository). A
-build of blead takes up about 200MB (including the repository and the
-check out).
+the blead branch (that is, the master branch, which contains bleadperl,
+the development version of perl 5) takes up about 160MB of disk space
+(including the repository). A build of bleadperl takes up about 200MB
+(including the repository and the check out).
 
 =head1 GETTING ACCESS TO THE REPOSITORY
 
@@ -53,7 +54,7 @@ This clones the repository and makes a local copy in the 'perl-ssh'
 directory.
 
 If you clone using git, which is faster than ssh, then you will need to
-modify your config in order to enable pushing. Edit .git/config where
+modify your config in order to enable pushing. Edit F<.git/config> where
 you will see something like:
 
   [remote "origin"]
@@ -77,22 +78,23 @@ will be the current branch as well, as indicated by the asterix.
   % git branch
   * blead
 
-Using the -a switch to branch will show the remote tracking branches in the
+Using the -a switch to branch will also show the remote tracking branches in the
 repository:
 
-  % git branch -r
+  % git branch -a
   * blead
     origin/HEAD
     origin/blead
   ...
 
 The branches that begin with "origin" correspond to the "git remote" that
-you cloned from. Each branch on the remote will be exactly tracked by theses
-branches. You should NEVER do work on these remote tracking branches. You only
-ever do work in a local branch. Local branches can be configured to automerge
-(on pull) from a designated remote tracking branch. This is the case with the
-default branch C<blead> which will be configured to merge from the remote
-tracking branch C<origin/blead>.
+you cloned from (which is named "origin"). Each branch on the remote will
+be exactly tracked by theses branches. You should NEVER do work on these
+remote tracking branches. You only ever do work in a local branch. Local
+branches can be configured to automerge (on pull) from a designated remote
+tracking branch. This is the case with the default branch C<blead> which
+will be configured to merge from the remote tracking branch
+C<origin/blead>.
 
 You can see recent commits:
 
@@ -114,13 +116,13 @@ directory you do:
 
   % git fetch
 
-And if you want to update your remote tracking branches for all defined remotes
-simultaneously you do
+And if you want to update your remote-tracking branches for all defined remotes
+simultaneously you can do
 
   % git remote update
 
 Neither of these last two commands will update your working directory, however
-both will update the repository.
+both will update the remote-tracking branches in your repository.
 
 To switch to another branch:
 
@@ -167,7 +169,7 @@ also shows that there was an untracked file in the working directory, and as
 you can see shows how to change all of this. It also shows that there
 is one commit on the  working branch C<blead> which has not been pushed to the
 C<origin> remote yet. B<NOTE>: that this output is also what you see as a
-template if you do not provide a message to c<git commit>.
+template if you do not provide a message to C<git commit>.
 
 Assuming we commit all the mentioned changes above:
 
@@ -320,7 +322,7 @@ If you are a committer to Perl and you think the patch is good, you can
 then merge it into blead then push it out to the main repository:
 
   % git checkout blead
-  % git pull . experimental
+  % git merge experimental
   % git push
 
 If you want to delete your temporary branch, you may do so with: