Changes between Version 65 and Version 66 of DeveloperGuidelines/Git

Timestamp:

09/18/13 10:48:09 (11 years ago)

Author:

Pat Tressel

Comment:

--

DeveloperGuidelines/Git

@@ -151 +151 @@
 
 
-==== Resetting to a previous commit ====
-There are two types of resets soft and hard.
-A soft reset is done like this:
-{{{
-git reset --soft HEAD@{N}
-}}}
-This resets your branch N previous commits (to a commit at a distance N from HEAD, the latest commit) but only in terms of git history. Hence your code remains untouched by git in a soft reset.
-
-A hard reset is done using:
-{{{
-git reset --hard HEAD@{N}
-}}}
-This resets your branch N previous commits removing both history and changes to the file ever since.
+==== Undoing a commit ====
+You may need to remove a commit you've made, either if you find you don't want it, or if it needs to be fixed. (Note if your commit has already been pushed to !GitHub and accepted into the trunk, then you should use a new commit to take out unwanted changes. This section only applies if you're fixing up your repository before the changes are in trunk.)
+
+If you want to fix up your latest commit, you can undo the commit, and unstage the files in it, by doing:
+{{{
+git reset HEAD~1
+}}}
+This will return your repository to its state before the git add commands that staged the files. Your changes will be in your working directory. HEAD~1 refers to the commit below the current tip of the branch.
+
+If you want to uncommit N commits, but keep the code changes in your working directory:
+{{{
+git reset HEAD~N
+}}}
+
+If you want to get rid of your latest commit, and do not want to keep the code changes, you can do a "hard" reset.
+{{{
+git reset --hard HEAD~1
+}}}
+
+Likewise, if you want to discard the last N commits, and do not want to keep the code changes:
+{{{
+git reset --hard HEAD~N
+}}}
+
+If you are not entirely sure you want to discard the code changes, but need a branch without them, you can simply check out a new branch that ends at the last commit you want. E.g. to make a branch that ends N commits before the latest:
+{{{
+git checkout -b <new_branch_name> HEAD~N
+}}}
+See below for more on using multiple branches.
  
-To remove commit from GitHub:
-{{{
-# Rebase locally (this allows you to remove the last commit)
-git rebase -i HEAD~2
-# Force update of GitHub
-git push origin +master
+To remove a commit from your repository on !GitHub, use either the hard reset or new branch method above to reset your local repository to the commit you want on !GitHub. !GitHub will not let you overwrite a branch with a different history unless you tell it to with the --force option. If your local and remote branches have the same names, you only need to specify the branch name once, without the ":".
+{{{
+git push --force origin <local_branch_name>:<github_branch_name>
 }}}