Merge pull request #1186 from rpjday/topic/rpjday/rewriting

Rewriting history: Minor cleanups; update "git rebase -i" menu

Author: ben

book/07-git-tools/sections/rewriting-history.asc

@@ -9,6 +9,7 @@ This can involve changing the order of the commits, changing messages or modifyi
 In this section, you'll see how to accomplish these tasks so that you can make your commit history look the way you want before you share it with others.
 
 [NOTE]
+.Don't push your work until you're happy with it
 ====
 One of the cardinal rules of Git is that, since so much work is local within your clone, you have a great deal of freedom to rewrite your history _locally_.
 However, once you push your work, it is a different story entirely, and you should consider pushed work as final unless you have good reason to change it.
@@ -68,8 +69,8 @@ It may be easier to remember the `~3` because you're trying to edit the last thr
 $ git rebase -i HEAD~3
 ----
 
-Remember again that this is a rebasing command – every commit included in the range `HEAD~3..HEAD` will be rewritten, whether you change the message or not.
-Don't include any commit you've already pushed to a central server – doing so will confuse other developers by providing an alternate version of the same change.
+Remember again that this is a rebasing command -- every commit included in the range `HEAD~3..HEAD` will be rewritten, whether you change the message or not.
+Don't include any commit you've already pushed to a central server -- doing so will confuse other developers by providing an alternate version of the same change.
 
 Running this command gives you a list of commits in your text editor that looks something like this:
 
@@ -82,12 +83,20 @@ pick a5f4a0d added cat-file
 # Rebase 710f0f8..a5f4a0d onto 710f0f8
 #
 # Commands:
-#  p, pick = use commit
-#  r, reword = use commit, but edit the commit message
-#  e, edit = use commit, but stop for amending
-#  s, squash = use commit, but meld into previous commit
-#  f, fixup = like "squash", but discard this commit's log message
-#  x, exec = run command (the rest of the line) using shell
+# p, pick <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# .       create a merge commit using the original merge commit's
+# .       message (or the oneline, if no original merge commit was
+# .       specified). Use -c <commit> to reword the commit message.
 #
 # These lines can be re-ordered; they are executed from top to bottom.
 #
@@ -193,12 +202,20 @@ The script puts helpful instructions in the rebase message:
 ----
 #
 # Commands:
-#  p, pick = use commit
-#  r, reword = use commit, but edit the commit message
-#  e, edit = use commit, but stop for amending
-#  s, squash = use commit, but meld into previous commit
-#  f, fixup = like "squash", but discard this commit's log message
-#  x, exec = run command (the rest of the line) using shell
+# p, pick <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# .       create a merge commit using the original merge commit's
+# .       message (or the oneline, if no original merge commit was
+# .       specified). Use -c <commit> to reword the commit message.
 #
 # These lines can be re-ordered; they are executed from top to bottom.
 #
@@ -282,7 +299,7 @@ Once again, this changes the SHA-1s of all the commits in your list, so make sur
 
 ==== The Nuclear Option: filter-branch
 
-There is another history-rewriting option that you can use if you need to rewrite a larger number of commits in some scriptable way – for instance, changing your email address globally or removing a file from every commit.
+There is another history-rewriting option that you can use if you need to rewrite a larger number of commits in some scriptable way -- for instance, changing your email address globally or removing a file from every commit.
 The command is `filter-branch`, and it can rewrite huge swaths of your history, so you probably shouldn't use it unless your project isn't yet public and other people haven't based work off the commits you're about to rewrite.
 However, it can be very useful.
 You'll learn a few of the common uses so you can get an idea of some of the things it's capable of.