435

I'm new to git and I'm trying to understand the difference between a squash and a rebase. As I understand it you perform a squash when doing a rebase.

Gnanam
  • 9,553
  • 18
  • 48
  • 71
GiH
  • 11,696
  • 13
  • 40
  • 53

4 Answers4

397

Both git merge --squash and git rebase --interactive can produce a "squashed" commit.
But they serve different purposes.

will produce a squashed commit on the destination branch, without marking any merge relationship.
(Note: it does not produce a commit right away: you need an additional git commit -m "squash branch")
This is useful if you want to throw away the source branch completely, going from (schema taken from SO question):

 git checkout stable

      X                   stable
     /                   
a---b---c---d---e---f---g tmp

to:

git merge --squash tmp
git commit -m "squash tmp"

      X-------------------G stable
     /                   
a---b---c---d---e---f---g tmp

and then deleting tmp branch.


Note: git merge has a --commit option, but it cannot be used with --squash. It was never possible to use --commit and --squash together.
Since Git 2.22.1 (Q3 2019), this incompatibility is made explicit:

See commit 1d14d0c (24 May 2019) by Vishal Verma (reloadbrain).
(Merged by Junio C Hamano -- gitster -- in commit 33f2790, 25 Jul 2019)

merge: refuse --commit with --squash

Previously, when --squash was supplied, 'option_commit' was silently dropped. This could have been surprising to a user who tried to override the no-commit behavior of squash using --commit explicitly.

git/git builtin/merge.c#cmd_merge() now includes:

if (option_commit > 0)
    die(_("You cannot combine --squash with --commit."));

replays some or all of your commits on a new base, allowing you to squash (or more recently "fix up", see this SO question), going directly to:

git checkout tmp
git rebase -i stable

      stable
      X-------------------G tmp
     /                     
a---b

If you choose to squash all commits of tmp (but, contrary to merge --squash, you can choose to replay some, and squashing others).

So the differences are:

  • squash does not touch your source branch (tmp here) and creates a single commit where you want.
  • rebase allows you to go on on the same source branch (still tmp) with:
    • a new base
    • a cleaner history
Arjun Balgovind
  • 556
  • 1
  • 5
  • 12
VonC
  • 1,042,979
  • 435
  • 3,649
  • 4,283
  • 15
    `G` is `c--d--e--f--g` squashed together? – Wayne Conrad Mar 11 '10 at 19:11
  • 9
    @Wayne: yes, G in those examples represent the `tmp` commits squashed together. – VonC Mar 11 '10 at 19:47
  • Isn't the data in `G` exactly the same as in `g`? So would that mean that `G` is the same as `g` except that it has a different parent? – Alexander Bird May 23 '11 at 14:15
  • 3
    @Th4wn: Since Git reasons with snapshots of a all project, `G` won't represent the same content than `g`, because of changes introduced by `X`. – VonC May 23 '11 at 19:04
  • Note to self: a "**cleaner history**" is important, considering a good Git workflow: http://sandofsky.com/blog/git-workflow.html – VonC Jul 31 '11 at 18:25
  • 1
    @VonC: not sure about that last comment. If you have a `git merge --no-ff temp` instead of `git merge --squash temp`, then you get a messier history, but you can also do things like `git revert e`, much more easily. It's a messy, but honest and pragmatic history, and the main branch still remains fairly clean. – naught101 Dec 13 '12 at 01:19
  • 2
    @naught101 I agree. As explained in http://stackoverflow.com/a/7425751/6309 though, it is also about not breaking `git bisect` or `git blame` when used too often (as in `git pull --no-ff`: http://stackoverflow.com/questions/12798767/fast-forward-when-using-pull-and-no-ff-when-pull/12798995#12798995). There isn't one approach anyway, which is why this article described three (http://stackoverflow.com/questions/9107861/git-merge-testing-branch-final-commit-to-master-branch/13470530#13470530) – VonC Dec 13 '12 at 06:24
  • 1
    Hmm - if say commit `c` involved deleting a file that was added in `a` so also present in `X` then `git merge --squash` would have this file in `G` - see [here](http://stackoverflow.com/a/14343784/281545). So G and g would be different versions of the working tree ! I don't know of other pitfalls but probably `git merge --squash` is not the way to mirror the state of `tmp` on `stable`. See also [this](http://stackoverflow.com/questions/1464642/git-merge-squash-repeatedly#comment23592425_4481621) – Mr_and_Mrs_D May 08 '13 at 18:37
  • 1
    When should I rebase and when should I squash? – Martin Thoma May 06 '16 at 07:07
  • 1
    @MartinThoma not that a rebase can also allow a squash (http://blog.ona.io/general/2016/02/02/squashing-with-git-interactive-rebase.html) More generally, you squash when you do not need the intermediate commits. This is a current practice when accenting a PR (Pull Request): see https://github.com/blog/2141-squash-your-commits – VonC May 06 '16 at 07:13
313

Merge commits: retains all of the commits in your branch and interleaves them with commits on the base branchenter image description here

Merge Squash: retains the changes but omits the individual commits from history enter image description here

Rebase: This moves the entire feature branch to begin on the tip of the master branch, effectively incorporating all of the new commits in master

enter image description here

More on here

Md Ayub Ali Sarker
  • 7,364
  • 2
  • 19
  • 18
93

Merge squash merges a tree (a sequence of commits) into a single commit. That is, it squashes all changes made in n commits into a single commit.

Rebasing is re-basing, that is, choosing a new base (parent commit) for a tree. Maybe the mercurial term for this is more clear: they call it transplant because it's just that: picking a new ground (parent commit, root) for a tree.

When doing an interactive rebase, you're given the option to either squash, pick, edit or skip the commits you are going to rebase.

Hope that was clear!

Mauricio Scheffer
  • 96,120
  • 20
  • 187
  • 273
  • 11
    When should I rebase and when should I squash? – Martin Thoma May 06 '16 at 07:07
  • 1
    @MartinThoma see: https://lwn.net/Articles/328436/ https://lwn.net/Articles/791284/ – Mauricio Scheffer Jun 29 '20 at 08:13
  • It does not matter which you use but I recommend rebase. Rebase changes the parent node of the feature branch but merge does not and I recommend it because it keeps the commit structure simpler but as a git user, it makes not different. https://stackoverflow.com/questions/2427238/in-git-what-is-the-difference-between-merge-squash-and-rebase#:~:text=Merge%20squash%20merges%20a%20tree,parent%20commit)%20for%20a%20tree. – max Sep 14 '20 at 18:38
75

Let's start by the following example:

enter image description here

Now we have 3 options to merge changes of feature branch into master branch:

  1. Merge commits
    Will keep all commits history of the feature branch and move them into the master branch
    Will add extra dummy commit.

  2. Rebase and merge
    Will append all commits history of the feature branch in the front of the master branch
    Will NOT add extra dummy commit.

  3. Squash and merge
    Will group all feature branch commits into one commit then append it in the front of the master branch
    Will add extra dummy commit.

You can find below how the master branch will look after each one of them.

enter image description here

In all cases:
We can safely DELETE the feature branch.

ahmednabil88
  • 13,263
  • 9
  • 45
  • 80
  • 2
    can you explain what is dummy commit in 2nd picture ?? I am a beginner in git. – Yusuf Jun 06 '20 at 14:57
  • 4
    @Yusuf, it's just an extra commit which contains both branches updates, it's default commit message = "Megre branch XYZ into master" – ahmednabil88 Jun 07 '20 at 16:10
  • 1
    For "Squash and merge": there is a commit with all grouped commits plus an "extra dummy commit"? – leticia Jul 27 '20 at 21:10
  • 2
    @leticia the commit with all grouped commits = the "extra dummy commit" itself, as the above graph – ahmednabil88 Jul 28 '20 at 07:19
  • Then I would argue that 'squash and merge' will not add an extra dummy commit, but rather will just 'rebase'/append the commit in front of the master branch. Dummy commit in the context you are describing it above is not the same in 1. and 3. as dummy commit in 1 is 'Merge branch XYZ into master which is producing this commit' and dummy commit in 3 is 'Squashed commits into this one commit which is not additional commit produced by merge' – BozanicJosip Feb 17 '21 at 12:21