What effect does the `--no-ff` flag have for `git merge`?
Asked Answered
S

7

1330

Using gitk log, I could not spot a difference between the effect of git merge and git merge --no-ff. How can I observe the difference (with a git command or some tool)?

Skullcap answered 30/1, 2012 at 18:45 Comment(3)
Possible duplicate of Git fast forward VS no fast forward merge.Yoong
Related: Why does git fast-forward merges by default?.Yoong
Possible duplicate of Git fast forward VS no fast forward mergeStites
T
1415

The --no-ff flag prevents git merge from executing a "fast-forward" if it detects that your current HEAD is an ancestor of the commit you're trying to merge. A fast-forward is when, instead of constructing a merge commit, git just moves your branch pointer to point at the incoming commit. This commonly occurs when doing a git pull without any local changes.

However, occasionally you want to prevent this behavior from happening, typically because you want to maintain a specific branch topology (e.g. you're merging in a topic branch and you want to ensure it looks that way when reading history). In order to do that, you can pass the --no-ff flag and git merge will always construct a merge instead of fast-forwarding.

Similarly, if you want to execute a git pull or use git merge in order to explicitly fast-forward, and you want to bail out if it can't fast-forward, then you can use the --ff-only flag. This way you can regularly do something like git pull --ff-only without thinking, and then if it errors out you can go back and decide if you want to merge or rebase.

Toleration answered 30/1, 2012 at 18:51 Comment(8)
To more directly answer the OP's question: they aren't always different, but if they are, it's clear from gitk or git log --graph that the fast-forward merge didn't create a merge commit, while the non-fast-forward one did.Aircrew
It would be nice to expand on the reason for avoiding ff: the author mentioned "specific branch topology" means that in --no-ff case an extra merge commit serves as the marker of the merge. The pros is explicit merge marker with names of the author and the merger. The cons is non-linear history that looks like a set of converging railroad tracks. A possible psychological side effect of the merge though is contributors loosing interest due to a longer review process: blog.spreedly.com/2014/06/24/…Macao
Would it be fair to say that --no-ff from a feature to develop or develop to master is similar to merging a pull request?Heliotropin
@merlinpatt Sure. If you merge a pull request in GitHub it does the equivalent of --no-ff.Toleration
This is a good explanation. Man, there's just not enough good git explanations out there for people to understand why clean git history is really, really important (me included!)Divinadivination
"if"? "prevents if"? The flag either prevents or not. It cannot prevent "... if". It is a flag, it just does. Without "if"sUpswing
"git merge will always construct a merge." To be more explicit, a new commit object will be created.Primatology
Is there any difference between git merge --no-ff feature and git merge feature --no-ff?Goiter
D
1320

Graphic answer to this question

Here is a site with a clear explanation and graphical illustration of using git merge --no-ff:

difference between git merge --no-ff and git merge

Until I saw this, I was completely lost with git. Using --no-ff allows someone reviewing history to clearly see the branch you checked out to work on. (that link points to github's "network" visualization tool) And here is another great reference with illustrations. This reference complements the first one nicely with more of a focus on those less acquainted with git.


Basic info for newbs like me

If you are like me, and not a Git-guru, my answer here describes handling the deletion of files from git's tracking without deleting them from the local filesystem, which seems poorly documented but often occurrence. Another newb situation is getting current code, which still manages to elude me.


Example Workflow

I updated a package to my website and had to go back to my notes to see my workflow; I thought it useful to add an example to this answer.

My workflow of git commands:

git checkout -b contact-form
(do your work on "contact-form")
git status
git commit -am  "updated form in contact module"
git checkout master
git merge --no-ff contact-form
git branch -d contact-form
git push origin master

Below: actual usage, including explanations.
Note: the output below is snipped; git is quite verbose.

$ git status
# On branch master
# Changed but not updated:
#   (use "git add/rm <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#       modified:   ecc/Desktop.php
#       modified:   ecc/Mobile.php
#       deleted:    ecc/ecc-config.php
#       modified:   ecc/readme.txt
#       modified:   ecc/test.php
#       deleted:    passthru-adapter.igs
#       deleted:    shop/mickey/index.php
#
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#       ecc/upgrade.php
#       ecc/webgility-config.php
#       ecc/webgility-config.php.bak
#       ecc/webgility-magento.php

Notice 3 things from above:
1) In the output you can see the changes from the ECC package's upgrade, including the addition of new files.
2) Also notice there are two files (not in the /ecc folder) I deleted independent of this change. Instead of confusing those file deletions with ecc, I'll make a different cleanup branch later to reflect those files' deletion.
3) I didn't follow my workflow! I forgot about git while I was trying to get ecc working again.

Below: rather than do the all-inclusive git commit -am "updated ecc package" I normally would, I only wanted to add the files in the /ecc folder. Those deleted files weren't specifically part of my git add, but because they already were tracked in git, I need to remove them from this branch's commit:

$ git checkout -b ecc
$ git add ecc/*
$ git reset HEAD passthru-adapter.igs
$ git reset HEAD shop/mickey/index.php
Unstaged changes after reset:
M       passthru-adapter.igs
M       shop/mickey/index.php

$ git commit -m "Webgility ecc desktop connector files; integrates with Quickbooks"

$ git checkout master
D       passthru-adapter.igs
D       shop/mickey/index.php
Switched to branch 'master'
$ git merge --no-ff ecc
$ git branch -d ecc
Deleted branch ecc (was 98269a2).
$ git push origin master
Counting objects: 22, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (14/14), done.
Writing objects: 100% (14/14), 59.00 KiB, done.
Total 14 (delta 10), reused 0 (delta 0)
To [email protected]:me/mywebsite.git
   8a0d9ec..333eff5  master -> master



Script for automating the above

Having used this process 10+ times in a day, I have taken to writing batch scripts to execute the commands, so I made an almost-proper git_update.sh <branch> <"commit message"> script for doing the above steps. Here is the Gist source for that script.

Instead of git commit -am I am selecting files from the "modified" list produced via git status and then pasting those in this script. This came about because I made dozens of edits but wanted varied branch names to help group the changes.

Danyelldanyelle answered 14/2, 2013 at 0:8 Comment(7)
Can you still safely delete a branch after do you a merge with the --no-ff option?Rebbeccarebe
@DesignerGuy yes you can safely delete the old branch. Think of branch es as just pointers to a specific commit.Chicoine
I found this text from the linked page helpful: without --no-ff "it is impossible to see from the Git history which of the commit objects together have implemented a feature — you would have to manually read all the log messages."Adames
one image always best than a thousand words !Chinookan
The graphic does not show the features branch in the second image, why not? It still exists doesn't it?Upset
That image alone got the job doneHeptad
@Upset In the second image, the commits which otherwise create "the branch" are just more commits along a series of commits. Visually, this would allow different features to be worked on concurrently. With a large enough codebase, there won't be any actual merging to perform.Danyelldanyelle
F
641

Merge Strategies

Explicit Merge (aka non fast-forward): Creates a new merge commit. (This is what you will get if you used --no-ff.)

enter image description here

Fast Forward Merge: Forward rapidly, without creating a new commit:

enter image description here

Rebase: Establish a new base level:

enter image description here

Note: Rebase merge looks simialr to fast-forward merge, the difference with ff merge is, HEAD of branch must be an ancestor of the commit we want to merge.

Squash: Crush or squeeze (something) with force so that it becomes flat:

enter image description here

Factotum answered 4/9, 2018 at 2:21 Comment(5)
So what's the difference between Rebase and fast-forward merge then?Relaxation
@Relaxation The diffference is, that for a ff merge the HEAD of the current branch must be an ancestor of the commit you want to merge. Like the answer from Lily Ballard above https://mcmap.net/q/14147/-what-effect-does-the-no-ff-flag-have-for-git-mergeWorker
@ThanosFisherman, Fast-Forward maintains the same base and tries to merge all file changes from the same changes after the shared base. A rebase "detaches" your branch, and then applies commit after commit on top of the base (as if you just checked out a fresh e.g. master branch), and THEN, tries to, apply the changes done on the new base. The rebase is usually used before you'd want to merge into master, so that it applies the topic-commits on top of master, without merge conflicts.Uncharted
What is "merge commit" from your first image? Where have the two red feature commits disappeared? Your merge commit looks like squashed commit, not a merge commit.Upswing
@Upswing What I understood is that in case of squash, through the merge commit we can not see the feature branch history however through no-ff we can. https://mcmap.net/q/14339/-is-there-a-difference-between-a-squash-merge-and-a-no-ff-merge-if-the-source-feature-branch-is-deleted-shortly-afterConstituent
T
257

The --no-ff option ensures that a fast forward merge will not happen, and that a new commit object will always be created. This can be desirable if you want git to maintain a history of feature branches.             git merge --no-ff vs git merge In the above image, the left side is an example of the git history after using git merge --no-ff and the right side is an example of using git merge where an ff merge was possible.

EDIT: A previous version of this image indicated only a single parent for the merge commit. Merge commits have multiple parent commits which git uses to maintain a history of the "feature branch" and of the original branch. The multiple parent links are highlighted in green.

Typesetter answered 12/2, 2014 at 2:33 Comment(9)
What does the green arrow indicate vs the black arrow?Safranine
the green arrow indicates a link between a commit and a parent where the commit has more than one parent. Normal commits (black) only have one parent.Typesetter
@DanielSmith How do you draw this elegant graph?Allisonallissa
@Allisonallissa with Adobe IllustratorTypesetter
Just to confirm my understanding, so with git merge --no-ff it will be easier to revert to a previous commit using a command like git reset --hard HEAD~1, correct? Whereas with the other one, it might get involved say if there are other interleaved commits in the master branch.Phobia
The graphic does not show the feature branch in the second image, why not? It still exists doesn't it?Upset
Yes it still exists in both cases and after the git merge it is identical to the master branch as all its commits have been fast forwarded onto master. In the git log you would see that both feature and master points to the same commit. In the git merge --no-ff case the feature branch would be missing the last merge commit.Quarrelsome
In that case they would not have an identical history although you would not see any difference when comparing what's in them. Their contents would be identical due to the fact that you actually could do a fast forward merge in this case.Quarrelsome
Did you read the article on nvie.com by Vincent Driessen? The graphic is presented as though it was original work.Danyelldanyelle
F
41

This is an old question, and this is somewhat subtly mentioned in the other posts, but the explanation that made this click for me is that non fast forward merges will require a separate commit.

Fatimahfatimid answered 2/4, 2014 at 19:56 Comment(3)
would you please review the workflow in my answer above: does this mean I need additional commits beyond what I've got now? Thanks.Danyelldanyelle
@ChrisK git merge --no-ff ecc you will simply have an additional merge commit in the git log for branch master. That is technically not needed in case master is pointing to a direct ancestor of the commit ecc is on but by specifying the --no-ff option you are forcing the creation of that merge commit. It will have the title: Merge branch 'ecc'Streaming
Great summary! :)Overline
B
12

The --no-ff flag causes the merge to always create a new commit object, even if the merge could be performed with a fast-forward. This avoids losing information about the historical existence of a feature branch and groups together all commits that together added the feature

Bilow answered 8/8, 2019 at 11:8 Comment(0)
W
10

Other answers indicate perfectly well that --no-ff results in a merge commit. This retains historical information about the feature branch which is useful since feature branches are regularly cleaned up and deleted.

This answer may provide context for when to use or not to use --no-ff.

Merging from feature into the main branch: use --no-ff

Worked example:

$ git checkout -b NewFeature
[work...work...work]
$ git commit -am  "New feature complete!"
$ git checkout main
$ git merge --no-ff NewFeature
$ git push origin main
$ git branch -d NewFeature

Merging changes from main into feature branch: leave off --no-ff

Worked example:

$ git checkout -b NewFeature
[work...work...work]
[New changes made for HotFix in the main branch! Lets get them...]
$ git commit -am  "New feature in progress"
$ git pull origin main
[shortcut for "git fetch origin main", "git merge origin main"]
Wait answered 14/12, 2020 at 14:25 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.