[perl #108754] perlgit.pod: Stress rebase more
authorFather Chrysostomos <sprout@cpan.org>
Fri, 3 Feb 2012 06:44:40 +0000 (22:44 -0800)
committerFather Chrysostomos <sprout@cpan.org>
Fri, 3 Feb 2012 06:44:40 +0000 (22:44 -0800)
Based on a patch from Andreas K├Ânig, but rearranged and reworded.

pod/perlgit.pod

index b14ad7e..ee524f9 100644 (file)
@@ -728,10 +728,18 @@ benefit from a summary of the set's purpose, you should use a merge
 commit.  You should perform your work on a L<topic branch|/Topic
 branches and rewriting history>, which you should regularly rebase
 against blead to ensure that your code is not broken by blead moving.
-When you have finished your work and performed a final rebase and test,
-you can merge it into master like this (assuming your work was on the
+When you have finished your work, please perform a final rebase and
+test.  Linear history is something that gets lost with every
+commit on blead, but a final rebase makes the history linear
+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
+
+Then you can merge it into master like this:
+
   $ git checkout blead
   $ git merge --no-ff --no-commit committer/somework
   $ git commit -a