This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlexperiment: document the private_use experiment
[perl5.git] / pod / perlgit.pod
index 9b5fe3f..2c7f5e8 100644 (file)
@@ -18,18 +18,18 @@ Perl, including those with write access to the git repository.
 =head1 CLONING THE REPOSITORY
 
 All of Perl's source code is kept centrally in a Git repository at
-I<perl5.git.perl.org>.
+I<github.com>.
 
 You can make a read-only clone of the repository by running:
 
-  % git clone git://perl5.git.perl.org/perl.git perl
+  % git clone git://github.com/Perl/perl5.git perl
 
 This uses the git protocol (port 9418).
 
 If you cannot use the git protocol for firewall reasons, you can also
-clone via http, though this is much slower:
+clone via http:
 
-  % git clone http://perl5.git.perl.org/perl.git perl
+  % git clone https://github.com/Perl/perl5.git perl
 
 =head1 WORKING WITH THE REPOSITORY
 
@@ -107,31 +107,33 @@ files, and in addition it will show things like what files have been
 staged for the next commit, and usually some useful information about
 how to change things. For instance the following:
 
-  $ git status
-  # On branch blead
-  # Your branch is ahead of 'origin/blead' by 1 commit.
-  #
-  # Changes to be committed:
-  #   (use "git reset HEAD <file>..." to unstage)
-  #
-  #       modified:   pod/perlgit.pod
-  #
-  # Changed but not updated:
-  #   (use "git add <file>..." to update what will be committed)
-  #
-  #       modified:   pod/perlgit.pod
-  #
-  # Untracked files:
-  #   (use "git add <file>..." to include in what will be committed)
-  #
-  #       deliberate.untracked
+ % git status
+ On branch blead
+ Your branch is ahead of 'origin/blead' by 1 commit.
+
+ Changes to be committed:
+   (use "git reset HEAD <file>..." to unstage)
+
+       modified:   pod/perlgit.pod
+
+ Changes not staged for commit:
+   (use "git add <file>..." to update what will be committed)
+   (use "git checkout -- <file>..." to discard changes in working
+                                                              directory)
+
+       modified:   pod/perlgit.pod
+
+ Untracked files:
+   (use "git add <file>..." to include in what will be committed)
+
+       deliberate.untracked
 
 This shows that there were changes to this document staged for commit,
 and that there were further changes in the working directory not yet
 staged. It 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
+not been pushed to the C<origin> remote yet. B<NOTE>: This output
 is also what you see as a template if you do not provide a message to
 C<git commit>.
 
@@ -177,35 +179,34 @@ to Orange Brocard, we should change his name in the AUTHORS file:
 You can see what files are changed:
 
   % git status
-  # On branch orange
-  # Changes to be committed:
-  #   (use "git reset HEAD <file>..." to unstage)
-  #
-  #    modified:   AUTHORS
-  #
+  On branch orange
+  Changes to be committed:
+    (use "git reset HEAD <file>..." to unstage)
+
+     modified:   AUTHORS
 
 And you can see the changes:
 
 % git diff
 diff --git a/AUTHORS b/AUTHORS
 index 293dd70..722c93e 100644
 --- a/AUTHORS
 +++ b/AUTHORS
 @@ -541,7 +541,7 @@    Lars Hecking                   <lhecking@nmrc.ucc.ie>
-   Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
-   Leif Huhn                      <leif@hale.dkstat.com>
-   Len Johnson                    <lenjay@ibm.net>
 -Leon Brocard                   <acme@astray.com>
 +Orange Brocard                 <acme@astray.com>
-   Les Peters                     <lpeters@aol.net>
-   Lesley Binks                   <lesley.binks@gmail.com>
-   Lincoln D. Stein               <lstein@cshl.org>
+ % git diff
+ diff --git a/AUTHORS b/AUTHORS
+ index 293dd70..722c93e 100644
+ --- a/AUTHORS
+ +++ b/AUTHORS
@@ -541,7 +541,7 @@    Lars Hecking              <lhecking@nmrc.ucc.ie>
+  Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
+  Leif Huhn                      <leif@hale.dkstat.com>
+  Len Johnson                    <lenjay@ibm.net>
+ -Leon Brocard                   <acme@astray.com>
+ +Orange Brocard                 <acme@astray.com>
+  Les Peters                     <lpeters@aol.net>
+  Lesley Binks                   <lesley.binks@gmail.com>
+  Lincoln D. Stein               <lstein@cshl.org>
 
 Now commit your change locally:
 
 % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
 Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
-   1 files changed, 1 insertions(+), 1 deletions(-)
+ % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
+ Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
+  1 files changed, 1 insertions(+), 1 deletions(-)
 
 The C<-a> option is used to include all files that git tracks that you
 have changed. If at this time, you only want to commit some of the
@@ -219,26 +220,27 @@ git will open a text editor for you to compose the message
 interactively. This is useful when the changes are more complex than
 the sample given here, and, depending on the editor, to know that the
 first line of the commit message doesn't exceed the 50 character legal
-maximum.
+maximum. See L<perlhack/Commit message> for more information about what
+makes a good commit message.
 
 Once you've finished writing your commit message and exited your
 editor, git will write your change to disk and tell you something like
 this:
 
 Created commit daf8e63: explain git status and stuff about remotes
-   1 files changed, 83 insertions(+), 3 deletions(-)
+ Created commit daf8e63: explain git status and stuff about remotes
+  1 files changed, 83 insertions(+), 3 deletions(-)
 
 If you re-run C<git status>, you should see something like this:
 
 % git status
-  # On branch blead
-  # Your branch is ahead of 'origin/blead' by 2 commits.
-  #
-  # Untracked files:
-  #   (use "git add <file>..." to include in what will be committed)
-  #
-  #       deliberate.untracked
-  nothing added to commit but untracked files present (use "git add" to track)
+ % git status
+ On branch orange
+ Untracked files:
+   (use "git add <file>..." to include in what will be committed)
+
+       deliberate.untracked
+
+ nothing added to commit but untracked files present (use "git add" to
+                                                                  track)
 
 When in doubt, before you do anything else, check your status and read
 it carefully, many questions are answered directly by the git status
@@ -253,101 +255,41 @@ itself you can fix it up by editing the files once more and then issue:
 
   % git commit -a --amend
 
-Now you should create a patch file for all your local changes:
-
-  % git format-patch -M origin..
-  0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
-
-You should now send an email to
-L<perlbug@perl.org|mailto:perlbug@perl.org> with a description of your
-changes, and include this patch file as an attachment. In addition to
-being tracked by RT, mail to perlbug will automatically be forwarded to
-perl5-porters (with manual moderation, so please be patient). You
-should only send patches to
-L<perl5-porters@perl.org|mailto:perl5-porters@perl.org> directly if the
-patch is not ready to be applied, but intended for discussion.
-
-See the next section for how to configure and use git to send these
-emails for you.
-
-If you want to delete your temporary branch, you may do so with:
-
-  % git checkout blead
-  % git branch -d orange
-  error: The branch 'orange' is not an ancestor of your current HEAD.
-  If you are sure you want to delete it, run 'git branch -D orange'.
-  % git branch -D orange
-  Deleted branch orange.
-
-=head2 Committing your changes
+Now, create a fork on GitHub to push your branch to, and add it as a
+remote if you haven't already, as described in the GitHub documentation
+at L<https://help.github.com/en/articles/working-with-forks>:
 
-Assuming that you'd like to commit all the changes you've made as a
-single atomic unit, run this command:
+  % git remote add fork git@github.com:MyUser/perl5.git
 
-   % git commit -a
+And push the branch to your fork:
 
-(That C<-a> tells git to add every file you've changed to this commit.
-New files aren't automatically added to your commit when you use
-C<commit -a> If you want to add files or to commit some, but not all of
-your changes, have a look at the documentation for C<git add>.)
+  % git push -u fork orange
 
-Git will start up your favorite text editor, so that you can craft a
-commit message for your change. See L<perlhack/Commit message> for more
-information about what makes a good commit message.
+You should now submit a Pull Request (PR) on GitHub from the new branch
+to blead. For more information, see the GitHub documentation at
+L<https://help.github.com/en/articles/creating-a-pull-request-from-a-fork>.
 
-Once you've finished writing your commit message and exited your
-editor, git will write your change to disk and tell you something like
-this:
-
-  Created commit daf8e63: explain git status and stuff about remotes
-   1 files changed, 83 insertions(+), 3 deletions(-)
-
-If you re-run C<git status>, you should see something like this:
-
-  % git status
-  # On branch blead
-  # Your branch is ahead of 'origin/blead' by 2 commits.
-  #
-  # Untracked files:
-  #   (use "git add <file>..." to include in what will be committed)
-  #
-  #       deliberate.untracked
-  nothing added to commit but untracked files present (use "git add" to track)
-
-When in doubt, before you do anything else, check your status and read
-it carefully, many questions are answered directly by the git status
-output.
-
-=head2 Using git to send patch emails
-
-Please read L<perlhack> first in order to figure out where your patches
-should be sent.
-
-In your ~/git/perl repository, set the destination email to perl's bug
-tracker:
-
-  $ git config sendemail.to perlbug@perl.org
-
-Or maybe perl5-porters:
+You can also send patch files to
+L<perl5-porters@perl.org|mailto:perl5-porters@perl.org> directly if the
+patch is not ready to be applied, but intended for discussion.
 
-  $ git config sendemail.to perl5-porters@perl.org
+To create a patch file for all your local changes:
 
-Then you can use git directly to send your patch emails:
+  % git format-patch -M blead..
+  0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 
-  $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
+Or for a lot of changes, e.g. from a topic branch:
 
-You may need to set some configuration variables for your particular
-email service provider. For example, to set your global git config to
-send email via a gmail account:
+  % git format-patch --stdout -M blead.. > topic-branch-changes.patch
 
-  $ git config --global sendemail.smtpserver smtp.gmail.com
-  $ git config --global sendemail.smtpssl 1
-  $ git config --global sendemail.smtpuser YOURUSERNAME@gmail.com
+If you want to delete your temporary branch, you may do so with:
 
-With this configuration, you will be prompted for your gmail password
-when you run 'git send-email'. You can also configure
-C<sendemail.smtppass> with your password if you don't care about having
-your password in the .gitconfig file.
+ % git checkout blead
+ % git branch -d orange
+ error: The branch 'orange' is not an ancestor of your current HEAD.
+ If you are sure you want to delete it, run 'git branch -D orange'.
+ % git branch -D orange
+ Deleted branch orange.
 
 =head2 A note on derived files
 
@@ -356,10 +298,10 @@ patching them, because git won't see the changes to them, and the build
 process will overwrite them. Patch the originals instead. Most
 utilities (like perldoc) are in this category, i.e. patch
 F<utils/perldoc.PL> rather than F<utils/perldoc>. Similarly, don't
-create patches for files under $src_root/ext from their copies found in
-$install_root/lib. If you are unsure about the proper location of a
-file that may have gotten copied while building the source
-distribution, consult the C<MANIFEST>.
+create patches for files under F<$src_root/ext> from their copies found
+in F<$install_root/lib>. If you are unsure about the proper location of
+file that may have gotten copied while building the source
+distribution, consult the F<MANIFEST>.
 
 =head2 Cleaning a working directory
 
@@ -375,7 +317,7 @@ However, be aware this will delete ALL untracked content. You can use
   % git clean -Xf
 
 to remove all ignored untracked files, such as build and test
-byproduct, but leave any  manually created files alone.
+byproduct, but leave any manually created files alone.
 
 If you only want to cancel some uncommitted edits, you can use C<git
 checkout> and give it a list of files to be reverted, or C<git checkout
@@ -401,8 +343,8 @@ you simply run this:
 
     .../Porting/bisect.pl -e 'my $a := 2;'
 
-Using C<bisect.pl>, with one command (and no other files) it's easy to find
-out
+Using F<Porting/bisect.pl>, with one command (and no other files) it's easy to
+find out
 
 =over 4
 
@@ -425,8 +367,8 @@ Which commit removed the last file to match this regex?
 =back
 
 usually without needing to know which versions of perl to use as start and
-end revisions, as F<bisect.pl> automatically searches to find the earliest
-stable version for which the test case passes. Run
+end revisions, as F<Porting/bisect.pl> automatically searches to find the
+earliest stable version for which the test case passes. Run
 C<Porting/bisect.pl --help> for the full documentation, including how to
 set the C<Configure> and build time options.
 
@@ -481,27 +423,35 @@ the "first commit where the bug is solved".
 C<git help bisect> has much more information on how you can tweak your
 binary searches.
 
+Following bisection you may wish to configure, build and test perl at
+commits identified by the bisection process.  Sometimes, particularly
+with older perls, C<make> may fail during this process.  In this case
+you may be able to patch the source code at the older commit point.  To
+do so, please follow the suggestions provided in
+L<perlhack/Building perl at older commits>.
+
 =head2 Topic branches and rewriting history
 
 Individual committers should create topic branches under
-B<yourname>/B<some_descriptive_name>. Other committers should check
-with a topic branch's creator before making any change to it.
+B<yourname>/B<some_descriptive_name>:
 
-The simplest way to create a remote topic branch that works on all
-versions of git is to push the current head as a new branch on the
-remote, then check it out locally:
+  % branch="$yourname/$some_descriptive_name"
+  % git checkout -b $branch
+  ... do local edits, commits etc ...
+  % git push origin -u $branch
 
-  $ branch="$yourname/$some_descriptive_name"
-  $ git push origin HEAD:$branch
-  $ git checkout -b $branch origin/$branch
+Should you be stuck with an ancient version of git (prior to 1.7), then
+C<git push> will not have the C<-u> switch, and you have to replace the
+last step with the following sequence:
 
-Users of git 1.7 or newer can do it in a more obvious manner:
+  % git push origin $branch:refs/heads/$branch
+  % git config branch.$branch.remote origin
+  % git config branch.$branch.merge refs/heads/$branch
 
-  $ branch="$yourname/$some_descriptive_name"
-  $ git checkout -b $branch
-  $ git push origin -u $branch
+If you want to make changes to someone else's topic branch, you should
+check with its creator before making any change to it.
 
-If you are not the creator of B<yourname>/B<some_descriptive_name>, you
+You
 might sometimes find that the original author has edited the branch's
 history. There are lots of good reasons for this. Sometimes, an author
 might simply be rebasing the branch onto a newer source point.
@@ -525,37 +475,37 @@ this via the following formula (see the explanation about C<refspec>'s
 in the git push documentation for details) after you have rebased your
 branch:
 
-   # first rebase
-   $ git checkout $user/$topic
-   $ git fetch
-   $ git rebase origin/blead
+  # first rebase
+  % git checkout $user/$topic
+  % git fetch
+  % git rebase origin/blead
 
-   # then "delete-and-push"
-   $ git push origin :$user/$topic
-   $ git push origin $user/$topic
+  # then "delete-and-push"
+  % git push origin :$user/$topic
+  % git push origin $user/$topic
 
 B<NOTE:> it is forbidden at the repository level to delete any of the
 "primary" branches. That is any branch matching
 C<m!^(blead|maint|perl)!>. Any attempt to do so will result in git
 producing an error like this:
 
-    $ git push origin :blead
-    *** It is forbidden to delete blead/maint branches in this repository
-    error: hooks/update exited with error code 1
-    error: hook declined to update refs/heads/blead
-    To ssh://perl5.git.perl.org/perl
-     ! [remote rejected] blead (hook declined)
-     error: failed to push some refs to 'ssh://perl5.git.perl.org/perl'
+  % git push origin :blead
+  *** It is forbidden to delete blead/maint branches in this repository
+  error: hooks/update exited with error code 1
+  error: hook declined to update refs/heads/blead
+  To ssh://perl5.git.perl.org/perl
+   ! [remote rejected] blead (hook declined)
+   error: failed to push some refs to 'ssh://perl5.git.perl.org/perl'
 
 As a matter of policy we do B<not> edit the history of the blead and
 maint-* branches. If a typo (or worse) sneaks into a commit to blead or
 maint-*, we'll fix it in another commit. The only types of updates
-allowed on these branches are "fast-forward's", where all history is
+allowed on these branches are "fast-forwards", where all history is
 preserved.
 
 Annotated tags in the canonical perl.git repository will never be
 deleted or modified. Think long and hard about whether you want to push
-a local tag to perl.git before doing so. (Pushing unannotated tags is
+a local tag to perl.git before doing so. (Pushing simple tags is
 not allowed.)
 
 =head2 Grafts
@@ -567,7 +517,7 @@ this is now impossible to fix in the public repository. You can remove
 this mis-merge locally by adding the following line to your
 C<.git/info/grafts> file:
 
 296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930
+ 296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930
 
 It is particularly important to have this graft line if any bisecting
 is done in the area of the "merge" in question.
@@ -578,7 +528,7 @@ Once you have write access, you will need to modify the URL for the
 origin remote to enable pushing. Edit F<.git/config> with the
 git-config(1) command:
 
-  % git config remote.origin.url ssh://perl5.git.perl.org/perl.git
+  % git config remote.origin.url git@github.com:Perl/perl5.git
 
 You can also set up your user name and e-mail address. Most people do
 this once globally in their F<~/.gitconfig> by doing something like:
@@ -586,7 +536,7 @@ this once globally in their F<~/.gitconfig> by doing something like:
   % git config --global user.name "Ævar Arnfjörð Bjarmason"
   % git config --global user.email avarab@gmail.com
 
-However if you'd like to override that just for perl then execute then
+However, if you'd like to override that just for perl,
 execute something like the following in F<perl>:
 
   % git config user.email avar@cpan.org
@@ -594,7 +544,7 @@ execute something like the following in F<perl>:
 It is also possible to keep C<origin> as a git remote, and add a new
 remote for ssh access:
 
-  % git remote add camel perl5.git.perl.org:/perl.git
+  % git remote add camel git@github.com:Perl/perl5.git
 
 This allows you to update your local repository by pulling from
 C<origin>, which is faster and doesn't require you to authenticate, and
@@ -606,6 +556,60 @@ to push your changes back with the C<camel> remote:
 The C<fetch> command just updates the C<camel> refs, as the objects
 themselves should have been fetched when pulling from C<origin>.
 
+=head2 Working with Github pull requests
+
+Pull requests typically originate from outside of the C<Perl/perl.git>
+repository, so if you want to test or work with it locally a vanilla
+C<git fetch> from the C<Perl/perl5.git> repository won't fetch it.
+
+However Github does provide a mechanism to fetch a pull request to a
+local branch.  They are available on Github remotes under C<pull/>, so
+you can use C<< git fetch pull/I<PRID>/head:I<localname> >> to make a
+local copy.  eg.  to fetch pull request 9999 to the local branch
+C<local-branch-name> run:
+
+  git fetch origin pull/9999/head:local-branch-name
+
+and then:
+
+  git checkout local-branch-name
+
+Note: this branch is not rebased on C<blead>, so instead of the
+checkout above, you might want:
+
+  git rebase origin/blead local-branch-name
+
+which rebases C<local-branch-name> on C<blead>, and checks it out.
+
+Alternatively you can configure the remote to fetch all pull requests
+as remote-tracking branches.  To do this edit the remote in
+F<.git/config>, for example if your github remote is C<origin> you'd
+have:
+
+  [remote "origin"]
+          url = git@github.com:/Perl/perl5.git
+          fetch = +refs/heads/*:refs/remotes/origin/*
+
+Add a line to map the remote pull request branches to remote-tracking
+branches:
+
+  [remote "origin"]
+          url = git@github.com:/Perl/perl5.git
+          fetch = +refs/heads/*:refs/remotes/origin/*
+          fetch = +refs/pull/*/head:refs/remotes/origin/pull/*
+
+and then do a fetch as normal:
+
+  git fetch origin
+
+This will create a remote-tracking branch for every pull request, including
+closed requests.
+
+To remove those remote-tracking branches, remove the line added above
+and prune:
+
+  git fetch -p origin # or git remote prune origin
+
 =head2 Accepting a patch
 
 If you have received a patch file generated using the above section,
@@ -614,58 +618,66 @@ you should try out the patch.
 First we need to create a temporary new branch for these changes and
 switch into it:
 
 % git checkout -b experimental
+ % git checkout -b experimental
 
 Patches that were formatted by C<git format-patch> are applied with
 C<git am>:
 
-  % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
-  Applying Rename Leon Brocard to Orange Brocard
+ % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
+ Applying Rename Leon Brocard to Orange Brocard
+
+Note that some UNIX mail systems can mess with text attachments containing
+'From '. This will fix them up:
+
+ % perl -pi -e's/^>From /From /' \
+                        0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
 
 If just a raw diff is provided, it is also possible use this two-step
 process:
 
-  % git apply bugfix.diff
-  % git commit -a -m "Some fixing" --author="That Guy <that.guy@internets.com>"
+ % git apply bugfix.diff
+ % git commit -a -m "Some fixing" \
+                            --author="That Guy <that.guy@internets.com>"
 
 Now we can inspect the change:
 
 % git show HEAD
 commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
 Author: Leon Brocard <acme@astray.com>
 Date:   Fri Dec 19 17:02:59 2008 +0000
-
-    Rename Leon Brocard to Orange Brocard
-
 diff --git a/AUTHORS b/AUTHORS
 index 293dd70..722c93e 100644
 --- a/AUTHORS
 +++ b/AUTHORS
 @@ -541,7 +541,7 @@ Lars Hecking                        <lhecking@nmrc.ucc.ie>
-   Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
-   Leif Huhn                      <leif@hale.dkstat.com>
-   Len Johnson                    <lenjay@ibm.net>
 -Leon Brocard                   <acme@astray.com>
 +Orange Brocard                 <acme@astray.com>
-   Les Peters                     <lpeters@aol.net>
-   Lesley Binks                   <lesley.binks@gmail.com>
-   Lincoln D. Stein               <lstein@cshl.org>
+ % git show HEAD
+ commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
+ Author: Leon Brocard <acme@astray.com>
+ Date:   Fri Dec 19 17:02:59 2008 +0000
+
+   Rename Leon Brocard to Orange Brocard
+
+ diff --git a/AUTHORS b/AUTHORS
+ index 293dd70..722c93e 100644
+ --- a/AUTHORS
+ +++ b/AUTHORS
@@ -541,7 +541,7 @@ Lars Hecking                 <lhecking@nmrc.ucc.ie>
+  Laszlo Molnar                  <laszlo.molnar@eth.ericsson.se>
+  Leif Huhn                      <leif@hale.dkstat.com>
+  Len Johnson                    <lenjay@ibm.net>
+ -Leon Brocard                   <acme@astray.com>
+ +Orange Brocard                 <acme@astray.com>
+  Les Peters                     <lpeters@aol.net>
+  Lesley Binks                   <lesley.binks@gmail.com>
+  Lincoln D. Stein               <lstein@cshl.org>
 
 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 merge experimental
-  % git push
+  % git push origin blead
 
 If you want to delete your temporary branch, you may do so with:
 
-  % git checkout blead
-  % git branch -d experimental
-  error: The branch 'experimental' is not an ancestor of your current HEAD.
-  If you are sure you want to delete it, run 'git branch -D experimental'.
-  % git branch -D experimental
-  Deleted branch experimental.
+ % git checkout blead
+ % git branch -d experimental
+ error: The branch 'experimental' is not an ancestor of your current
+ HEAD.  If you are sure you want to delete it, run 'git branch -D
+ experimental'.
+ % git branch -D experimental
+ Deleted branch experimental.
 
 =head2 Committing to blead
 
@@ -687,8 +699,8 @@ message> for details.
 Run the test suite. You might not think that one typo fix would break a
 test file. You'd be wrong. Here's an example of where not running the
 suite caused problems. A patch was submitted that added a couple of
-tests to an existing .t. It couldn't possibly affect anything else, so
-no need to test beyond the single affected .t, right?  But, the
+tests to an existing F<.t>. It couldn't possibly affect anything else, so
+no need to test beyond the single affected F<.t>, right?  But, the
 submitter's email address had changed since the last of their
 submissions, and this caused other tests to fail. Running the test
 target given in the next item would have caught this problem.
@@ -719,19 +731,20 @@ Sometimes, blead will move while you're building or testing your
 changes.  When this happens, your push will be rejected with a message
 like this:
 
-  To ssh://perl5.git.perl.org/perl.git
-   ! [rejected]        blead -> blead (non-fast-forward)
-  error: failed to push some refs to 'ssh://perl5.git.perl.org/perl.git'
-  To prevent you from losing history, non-fast-forward updates were rejected
-  Merge the remote changes (e.g. 'git pull') before pushing again.  See the
-  'Note about fast-forwards' section of 'git push --help' for details.
+ To ssh://perl5.git.perl.org/perl.git
+  ! [rejected]        blead -> blead (non-fast-forward)
+ error: failed to push some refs to 'ssh://perl5.git.perl.org/perl.git'
+ To prevent you from losing history, non-fast-forward updates were
+ rejected Merge the remote changes (e.g. 'git pull') before pushing
+ again.  See the 'Note about fast-forwards' section of 'git push --help'
+ for details.
 
 When this happens, you can just I<rebase> your work against the new
 position of blead, like this (assuming your remote for the master
 repository is "p5p"):
 
-  $ git fetch p5p
-  $ git rebase p5p/blead
+  % git fetch p5p
+  % git rebase p5p/blead
 
 You will see your commits being re-applied, and you will then be able to
 push safely.  More information about rebasing can be found in the
@@ -749,14 +762,14 @@ again, making it easier for future maintainers to see what has
 happened.  Rebase as follows (assuming your work was on the
 branch C<< committer/somework >>):
 
-  $ git checkout committer/somework
-  $ git rebase blead
+  % git checkout committer/somework
+  % git rebase blead
 
 Then you can merge it into master like this:
 
-  $ git checkout blead
-  $ git merge --no-ff --no-commit committer/somework
-  $ git commit -a
+  % git checkout blead
+  % git merge --no-ff --no-commit committer/somework
+  % git commit -a
 
 The switches above deserve explanation.  C<--no-ff> indicates that even
 if all your work can be applied linearly against blead, a merge commit
@@ -797,35 +810,6 @@ original commit in the new commit message.
 Before pushing any change to a maint version, make sure you've
 satisfied the steps in L</Committing to blead> above.
 
-=head2 Merging from a branch via GitHub
-
-While we don't encourage the submission of patches via GitHub, that
-will still happen. Here is a guide to merging patches from a GitHub
-repository.
-
-  % git remote add avar git://github.com/avar/perl.git
-  % git fetch avar
-
-Now you can see the differences between the branch and blead:
-
-  % git diff avar/orange
-
-And you can see the commits:
-
-  % git log avar/orange
-
-If you approve of a specific commit, you can cherry pick it:
-
-  % git cherry-pick 0c24b290ae02b2ab3304f51d5e11e85eb3659eae
-
-Or you could just merge the whole branch if you like it all:
-
-  % git merge avar/orange
-
-And then push back to the repository:
-
-  % git push
-
 =head2 Using a smoke-me branch to test changes
 
 Sometimes a change affects code paths which you cannot test on the OSes
@@ -835,9 +819,12 @@ on other OSes test the change before you commit it to blead.
 Fortunately, there is a way to get your change smoke-tested on various
 OSes: push it to a "smoke-me" branch and wait for certain automated
 smoke-testers to report the results from their OSes.
+A "smoke-me" branch is identified by the branch name: specifically, as
+seen on github.com it must be a local branch whose first name
+component is precisely C<smoke-me>.
 
 The procedure for doing this is roughly as follows (using the example of
-of tonyc's smoke-me branch called win32stat):
+tonyc's smoke-me branch called win32stat):
 
 First, make a local branch and switch to it:
 
@@ -889,32 +876,11 @@ Finally, you should then delete the remote smoke-me branch:
 
 (which is likely to produce a warning like this, which can be ignored:
 
-  remote: fatal: ambiguous argument 'refs/heads/smoke-me/tonyc/win32stat': unknown revision or path not in the working tree.
-  remote: Use '--' to separate paths from revisions
+ remote: fatal: ambiguous argument
+                                  'refs/heads/smoke-me/tonyc/win32stat':
+ unknown revision or path not in the working tree.
+ remote: Use '--' to separate paths from revisions
 
 ) and then delete your local branch:
 
   % git branch -d win32stat
-
-=head2 A note on camel and dromedary
-
-The committers have SSH access to the two servers that serve
-C<perl5.git.perl.org>. One is C<perl5.git.perl.org> itself (I<camel>),
-which is the 'master' repository. The second one is
-C<users.perl5.git.perl.org> (I<dromedary>), which can be used for
-general testing and development. Dromedary syncs the git tree from
-camel every few minutes, you should not push there. Both machines also
-have a full CPAN mirror in /srv/CPAN, please use this. To share files
-with the general public, dromedary serves your ~/public_html/ as
-C<http://users.perl5.git.perl.org/~yourlogin/>
-
-These hosts have fairly strict firewalls to the outside. Outgoing, only
-rsync, ssh and git are allowed. For http and ftp, you can use
-http://webproxy:3128 as proxy. Incoming, the firewall tries to detect
-attacks and blocks IP addresses with suspicious activity. This
-sometimes (but very rarely) has false positives and you might get
-blocked. The quickest way to get unblocked is to notify the admins.
-
-These two boxes are owned, hosted, and operated by booking.com. You can
-reach the sysadmins in #p5p on irc.perl.org or via mail to
-C<perl5-porters@perl.org>.