Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Edit a merge commit with git rebase

Tags:

git

rebase

In Git when I have commits eg. A - B - C and I want to edit the B commit, I

  • use git rebase -i <A-commit-hash>,
  • in the list I write edit command in front of B commit,
  • git rebase stops right after B commit so I can fix anything I want using git commit --amend,
  • and then I continue using git rebase --continue.

As far as I know this is the best practice how to do this. With this method I can edit any commit in the past (as long as it hasn't been pushed to remote branch yet), and moreover with -p flag I can even preserve the merges. This is just great.

My current problem is: I did a mistake (typo) on one line in a merge commit (while resolving a conflict when merging two branches).

I'd like to fix it but I don't know how to make git rebase to stop at a merge commit. The git rebase -p -i <blah> list ignores merge commits, so I cannot write edit command in front of it and make the git rebase stop there to let me edit it.

Any help please? I just want to fix this line in the merge commit while preserving all the commits (and merges) after it.

Thanks.

like image 950
vasekch Avatar asked Mar 29 '12 17:03

vasekch


People also ask

How do I edit a commit in rebase?

Use the awesome interactive rebase:Find the commit you want, change pick to e ( edit ), and save and close the file. Git will rewind to that commit, allowing you to either: use git commit --amend to make changes, or.

Can I rebase a merge?

The Rebase Option But, instead of using a merge commit, rebasing re-writes the project history by creating brand new commits for each commit in the original branch. The major benefit of rebasing is that you get a much cleaner project history. First, it eliminates the unnecessary merge commits required by git merge .

Does rebasing remove merge commits?

Git has two different methods to sync branches: rebase and merge . Rebase offers a cleaner way to maintain the repository, while merge offers a one-click solution. Rebase is powerful, but it comes with a price. One problem I face with rebase is, it removes merge commits.

How do I change the commit message in merge request?

Change the commit message. You can use git commit --amend for the latest commit change. It must be the latest commit. Amend it.


1 Answers

Updated answer for 2020:

You can force git rebase -i to stop at the merge commit via the break command (added in Git 2.20). You can then edit the merge commit as desired via git commit --amend.

Detailed steps:

  1. Run git rebase -i --rebase-merges $ancestor_of_merge_commit
  2. Find the merge commit you want to edit in the todo list.
  3. Insert a new line after the merge commit that contains only break (or b).
  4. Save your changes and exit your editor. Git rebase will check out the merge commit, print something like the following, then return you to your prompt:
    Stopped at fb91fab (Merge branch 'foo' into bar) 
  5. Use git commit --amend to edit the merge commit as desired.
  6. Run git rebase --continue when you are done editing the merge commit.

Alternative approach if you do not have any merge commits after the commit you want to edit:

  1. Run git rebase -i $id_of_merge_commit
  2. Insert a new line at the top of the todo list that contains only break (or b).
  3. Save your changes and exit your editor. Git rebase will check out the merge commit, print something like the following, then return you to your prompt:
    Stopped at fb91fab (Merge branch 'foo' into bar) 
  4. Use git commit --amend to edit the merge commit as desired.
  5. Run git rebase --continue when you are done editing the merge commit.

Original answer from 2012 (pre-break):

Git does not make it easy to do interactive rebases when merges are involved. The -p option uses the -i mechanism internally, so mixing the two doesn't really work.

However, git rebase is just an automated way to do lots of cherry-picks. You can replicate its behavior by manually cherry-picking to get a bit more control over the process. It's less convenient and more prone to human error, but possible.

This is the approach I suggest:

  1. use git rebase to get to the commit after the merge (the child of the merge)
  2. use git reset --hard HEAD^ to manually get to the merge
  3. use git commit --amend to repair the merge
  4. use git cherry-pick to get back to the commit after the merge
  5. use git rebase --continue to finish

Here are the specific steps:

  1. Note the SHA1 ID of the merge commit you want to modify. For discussion, suppose it is deadbeef.
  2. Note the SHA1 ID of the commit right after the merge commit you want to modify (the merge commit's child). Suppose it is facef00d.
  3. Run git rebase -i deadbeef.
  4. Select facef00d for editing.
  5. When rebase returns you to a prompt to edit facef00d, run git reset --hard HEAD^. You should now be at deadbeef (git rev-parse HEAD should print deadbeef).
  6. Make your edits to fix the incorrect merge conflict and use git add to stage them.
  7. Run git commit --amend to fuse the staged fix with the bad merge commit. The result will now have a different SHA1 (not deadbeef).
  8. Run git cherry-pick facef00d to apply the changes made by facef00d to the fixed merge commit.
  9. Run git rebase --continue to finish.
like image 159
Richard Hansen Avatar answered Sep 21 '22 15:09

Richard Hansen