I'm using Git on a new project that has two parallel -- but currently experimental -- development branches:
master: import of existing codebase plus a few modifications that I'm generally sure of
exp1: experimental branch #1
exp2: experimental branch #2
exp1
and exp2
represent two very different architectural approaches. Until I get further along I have no way of knowing which one (if either) will work. As I make progress in one branch I sometimes have edits that would be useful in the other branch and would like to merge just those.
What is the best way to merge selective changes from one development branch to another while leaving behind everything else?
Approaches I've considered:
git merge --no-commit followed by manual unstaging of a large number of edits that I don't want to make common between the branches. Manual copying of common files into a temporary directory followed by git checkout to move to the other branch and then more manual copying out of the temporary directory into the working tree. A variation on the above. Abandon the exp branches for now and use two additional local repositories for experimentation. This makes the manual copying of files much more straightforward.
All three of these approaches seem tedious and error-prone. I'm hoping there is a better approach; something akin to a filter path parameter that would make git-merge
more selective.
git merge -s ours --no-commit
followed by some git read-tree
be a good solution for this? See stackoverflow.com/questions/1214906/…
I had the exact same problem as mentioned by you above. But I found this clearer in explaining the answer.
Summary:
Check out the path(s) from the branch you want to merge, $ git checkout source_branch --
or to selectively merge hunks $ git checkout -p source_branch --
Alternatively, use reset and then add with the option -p
,
$ git reset <paths>...
$ git add -p <paths>...
Finally commit $ git commit -m "'Merge' these changes"
You use the cherry-pick command to get individual commits from one branch.
If the change(s) you want are not in individual commits, then use the method shown here to split the commit into individual commits. Roughly speaking, you use git rebase -i
to get the original commit to edit, then git reset HEAD^
to selectively revert changes, then git commit
to commit that bit as a new commit in the history.
There is another nice method here in Red Hat Magazine, where they use git add --patch
or possibly git add --interactive
which allows you to add just parts of a hunk, if you want to split different changes to an individual file (search in that page for "split").
Having split the changes, you can now cherry-pick just the ones you want.
To selectively merge files from one branch into another branch, run
git merge --no-ff --no-commit branchX
where branchX
is the branch you want to merge from into the current branch.
The --no-commit
option will stage the files that have been merged by Git without actually committing them. This will give you the opportunity to modify the merged files however you want to and then commit them yourself.
Depending on how you want to merge files, there are four cases:
1) You want a true merge.
In this case, you accept the merged files the way Git merged them automatically and then commit them.
2) There are some files you don't want to merge.
For example, you want to retain the version in the current branch and ignore the version in the branch you are merging from.
To select the version in the current branch, run:
git checkout HEAD file1
This will retrieve the version of file1
in the current branch and overwrite the file1
automerged by Git.
3) If you want the version in branchX (and not a true merge).
Run:
git checkout branchX file1
This will retrieve the version of file1
in branchX
and overwrite file1
auto-merged by Git.
4) The last case is if you want to select only specific merges in file1.
In this case, you can edit the modified file1
directly, update it to whatever you'd want the version of file1
to become, and then commit.
If Git cannot merge a file automatically, it will report the file as "unmerged" and produce a copy where you will need to resolve the conflicts manually.
To explain further with an example, let's say you want to merge branchX
into the current branch:
git merge --no-ff --no-commit branchX
You then run the git status
command to view the status of modified files.
For example:
git status
# On branch master
# Changes to be committed:
#
# modified: file1
# modified: file2
# modified: file3
# Unmerged paths:
# (use "git add/rm <file>..." as appropriate to mark resolution)
#
# both modified: file4
#
Where file1
, file2
, and file3
are the files git have successfully auto-merged.
What this means is that changes in the master
and branchX
for all those three files have been combined together without any conflicts.
You can inspect how the merge was done by running the git diff --cached
;
git diff --cached file1
git diff --cached file2
git diff --cached file3
If you find some merge undesirable then you can
edit the file directly save git commit
If you don't want to merge file1 and want to retain the version in the current branch
Run
git checkout HEAD file1
If you don't want to merge file2 and only want the version in branchX
Run
git checkout branchX file2
If you want file3 to be merged automatically, don't do anything.
Git has already merged it at this point.
file4
above is a failed merge by Git. This means there are changes in both branches that occur on the same line. This is where you will need to resolve the conflicts manually. You can discard the merged done by editing the file directly or running the checkout command for the version in the branch you want file4
to become.
Finally, don't forget to git commit
.
git merge --no-commit branchX
is just a fast-forward, the pointer will be updated, and the --no-commit is thus silently ignored
--no-ff
to prevent that behavior?
I don't like the above approaches. Using cherry-pick is great for picking a single change, but it is a pain if you want to bring in all the changes except for some bad ones. Here is my approach.
There is no --interactive
argument you can pass to git merge.
Here is the alternative:
You have some changes in branch 'feature' and you want to bring some but not all of them over to 'master' in a not sloppy way (i.e. you don't want to cherry pick and commit each one)
git checkout feature
git checkout -b temp
git rebase -i master
# Above will drop you in an editor and pick the changes you want ala:
pick 7266df7 First change
pick 1b3f7df Another change
pick 5bbf56f Last change
# Rebase b44c147..5bbf56f onto b44c147
#
# Commands:
# pick = use commit
# edit = use commit, but stop for amending
# squash = use commit, but meld into previous commit
#
# If you remove a line here THAT COMMIT WILL BE LOST.
# However, if you remove everything, the rebase will be aborted.
#
git checkout master
git pull . temp
git branch -d temp
So just wrap that in a shell script, change master into $to and change feature into $from and you are good to go:
#!/bin/bash
# git-interactive-merge
from=$1
to=$2
git checkout $from
git checkout -b ${from}_tmp
git rebase -i $to
# Above will drop you in an editor and pick the changes you want
git checkout $to
git pull . ${from}_tmp
git branch -d ${from}_tmp
git rebase -i $to
to git rebase -i $to || $SHELL
, so that the user can call git --skip
etc, as necessary if the rebase fails. Also worth chaining the lines together with &&
instead of newlines.
There is another way to go:
git checkout -p
It is a mix between git checkout
and git add -p
and might quite be exactly what you are looking for:
-p, --patch
Interactively select hunks in the difference between the <tree-ish>
(or the index, if unspecified) and the working tree. The chosen
hunks are then applied in reverse to the working tree (and if a
<tree-ish> was specified, the index).
This means that you can use git checkout -p to selectively discard
edits from your current working tree. See the “Interactive Mode”
section of git-add(1) to learn how to operate the --patch mode.
While some of these answers are pretty good, I feel like none actually answered the OP's original constraint: selecting particular files from particular branches. This solution does that, but it may be tedious if there are many files.
Let’s say you have the master
, exp1
, and exp2
branches. You want to merge one file from each of the experimental branches into master. I would do something like this:
git checkout master
git checkout exp1 path/to/file_a
git checkout exp2 path/to/file_b
# Save these files as a stash
git stash
# Merge stash with master
git merge stash
This will give you in-file diffs for each of the files you want. Nothing more. Nothing less. It's useful you have radically different file changes between versions --in my case, changing an application from Ruby on Rails 2 to Ruby on Rails 3.
This will merge files, but it does a smart merge. I wasn't able to figure out how to use this method to get in-file diff information (maybe it still will for extreme differences. Annoying small things like whitespace get merged back in unless you use the -s recursive -X ignore-all-space
option)
git checkout exp1 path/to/file_a path/to/file_x
git checkout feature <path>/*
to get groups of files.
1800 INFORMATION's answer is completely correct. As someone new to Git, though, "use git cherry-pick" wasn't enough for me to figure this out without a bit more digging on the Internet, so I thought I'd post a more detailed guide in case anyone else is in a similar boat.
My use case was wanting to selectively pull changes from someone else's GitHub branch into my own. If you already have a local branch with the changes, you only need to do steps 2 and 5-7.
Create (if not created) a local branch with the changes you want to bring in. $ git branch mybranch
git cherry
command (see manual first) to identify commits you haven't yet merged.
https://www.sourcemage.org
is requesting your username and password. The site says: 'Restricted Zone'". (It is also redirecting to HTTPS.)
Here is how you can replace Myclass.java
file in master
branch with Myclass.java
in feature1
branch. It will work even if Myclass.java
doesn't exist on master
.
git checkout master
git checkout feature1 Myclass.java
Note this will overwrite - not merge - and ignore local changes in the master branch rather.
theirs
overwrite ours
=> +1 Cheers ;)
2. Manual copying of common files into a temp directory followed by ...copying out of the temp directory into the working tree.
The simple way, to actually merge specific files from two branches, not just replace specific files with ones from another branch.
Step one: Diff the branches
git diff branch_b > my_patch_file.patch
Creates a patch file of the difference between the current branch and branch_b
Step two: Apply the patch on files matching a pattern
git apply -p1 --include=pattern/matching/the/path/to/file/or/folder my_patch_file.patch
Useful notes on the options
You can use *
as a wildcard in the include pattern.
Slashes don't need to be escaped.
Also, you could use --exclude instead and apply it to everything except the files matching the pattern, or reverse the patch with -R
The -p1 option is a holdover from the *Unix patch command and the fact that the patch file's contents prepend each file name with a/
or b/
(or more depending on how the patch file was generated) which you need to strip, so that it can figure out the real file to the path to the file the patch needs to be applied to.
Check out the man page for git-apply for more options.
Step three: there is no step three
Obviously you'd want to commit your changes, but who's to say you don't have some other related tweaks you want to do before making your commit.
Here's how you can get history to follow just a couple of files from another branch with a minimum of fuss, even if a more "simple" merge would have brought over a lot more changes that you don't want.
First, you'll take the unusual step of declaring in advance that what you're about to commit is a merge, without Git doing anything at all to the files in your working directory:
git merge --no-ff --no-commit -s ours branchname1
... where "branchname" is whatever you claim to be merging from. If you were to commit right away, it would make no changes, but it would still show ancestry from the other branch. You can add more branches, tags, etc. to the command line if you need to, as well. At this point though, there are no changes to commit, so get the files from the other revisions, next.
git checkout branchname1 -- file1 file2 etc.
If you were merging from more than one other branch, repeat as needed.
git checkout branchname2 -- file3 file4 etc.
Now the files from the other branch are in the index, ready to be committed, with history.
git commit
And you'll have a lot of explaining to do in that commit message.
Please note though, in case it wasn't clear, that this is a messed up thing to do. It is not in the spirit of what a "branch" is for, and cherry-pick is a more honest way to do what you'd be doing, here. If you wanted to do another "merge" for other files on the same branch that you didn't bring over last time, it will stop you with an "already up to date" message. It's a symptom of not branching when we should have, in that the "from" branch should be more than one different branch.
git merge --no-ff --no-commit -s outs branchname1
) is exactly what I was looking for! Thanks!
git merge --continue
instead of the final git commit
. Thanks!
This is my workflow for merging selective files.
# Make a new branch (this will be temporary)
git checkout -b newbranch
# Grab the changes
git merge --no-commit featurebranch
# Unstage those changes
git reset HEAD
(You can now see the files from the merge are unstaged)
# Now you can chose which files are to be merged.
git add -p
# Remember to "git add" any new files you wish to keep
git commit
The easiest way is to set your repository to the branch you want to merge with, and then run
git checkout [branch with file] [path to file you would like to merge]
If you run
git status
you will see the file already staged...
Then run
git commit -m "Merge changes on '[branch]' to [file]"
Simple.
It's strange that git still does not have such a convenient tool "out of the box". I use it heavily when update some old version branch (which still has a lot of software users) by just some bugfixes from the current version branch. In this case it is often needed to quickly get just some lines of code from the file in trunk, ignoring a lot of other changes (that are not supposed to go into the old version)... And of course interactive three-way merge is needed in this case, git checkout --patch <branch> <file path>
is not usable for this selective merge purpose.
You can do it easily:
Just add this line to [alias]
section in your global .gitconfig
or local .git/config
file:
[alias]
mergetool-file = "!sh -c 'git show $1:$2 > $2.theirs; git show $(git merge-base $1 $(git rev-parse HEAD)):$2 > $2.base; /C/BCompare3/BCompare.exe $2.theirs $2 $2.base $2; rm -f $2.theirs; rm -f $2.base;' -"
It implies you use Beyond Compare. Just change to software of your choice if needed. Or you can change it to three-way auto-merge if you don't need the interactive selective merging:
[alias]
mergetool-file = "!sh -c 'git show $1:$2 > $2.theirs; git show $(git merge-base $1 $(git rev-parse HEAD)):$2 > $2.base; git merge-file $2 $2.base $2.theirs; rm -f $2.theirs; rm -f $2.base;' -"
Then use like this:
git mergetool-file <source branch> <file path>
This will give you the true selective tree-way merge opportunity of just any file in other branch.
I found this post to contain the simplest answer. Merely do:
git checkout <branch from which you want files> <file paths>
Example
Pulling .gitignore file from branchB into current branch:
git checkout branchB .gitignore
See the post for more information.
It is not exactly what you were looking for, but it was useful to me:
git checkout -p <branch> -- <paths> ...
It is a mix of some answers.
git checkout HEAD file1
to keep the current version and unmerge the file file1
, one can use -p
option to select part of the file to be merged. thanks for the trick!
I had the exact same problem as mentioned by you above. But I found this Git blog clearer in explaining the answer.
Command from the above link:
# You are in the branch you want to merge to
git checkout <branch_you_want_to_merge_from> <file_paths...>
For me, git reset --soft branch
is the easiest way to selectively pick the changes from another branch, since, this command puts in my working tree, all the diff changes, and I can easily pick or revert which one I need.
In this way, I have full control over the committed files.
I would do a
git diff commit1..commit2 filepattern | git-apply --index && git commit
This way you can limit the range of commits for a filepattern from a branch.
It is stolen from Re: How to pull only a few files from one branch to another?
git checkout branch ...
below - the local changes not present in branch
are removed(!). They are marked as "removed" in the patch file as plain diff does not check the commits history.
You can use read-tree
to read or merge a given remote tree into the current index, for example:
git remote add foo git@example.com/foo.git
git fetch foo
git read-tree --prefix=my-folder/ -u foo/master:trunk/their-folder
To perform the merge, use -m
instead.
See also: How do I merge a sub directory in Git?
I like the previous 'git-interactive-merge' answer, but there's one easier. Let Git do this for you using a rebase combination of interactive and onto:
A---C1---o---C2---o---o feature
/
----o---o---o---o master
So the case is you want C1 and C2 from the 'feature' branch (branch point 'A'), but none of the rest for now.
# git branch temp feature
# git checkout master
# git rebase -i --onto HEAD A temp
Which, as in the previous answer, drops you in to the interactive editor where you select the 'pick' lines for C1 and C2 (as above). Save and quit, and then it will proceed with the rebase and give you branch 'temp' and also HEAD at master + C1 + C2:
A---C1---o---C2---o---o feature
/
----o---o---o---o-master--C1---C2 [HEAD, temp]
Then you can just update master to HEAD and delete the temp branch and you're good to go:
# git branch -f master HEAD
# git branch -d temp
I wrote my own script called 'pmerge' to partially merge directories. It's a work in progress and I'm still learning both Git and Bash scripting.
This command uses git merge --no-commit
and then unapplies changes that don't match the path provided.
Usage: git pmerge branch path
Example: git merge develop src/
I haven't tested it extensively. The working directory should be free of any uncommitted changes and untracked files.
#!/bin/bash
E_BADARGS=65
if [ $# -ne 2 ]
then
echo "Usage: `basename $0` branch path"
exit $E_BADARGS
fi
git merge $1 --no-commit
IFS=$'\n'
# List of changes due to merge | replace nulls with newlines | strip lines to just filenames | ensure lines are unique
for f in $(git status --porcelain -z -uno | tr '\000' '\n' | sed -e 's/^[[:graph:]][[:space:]]\{1,\}//' | uniq); do
[[ $f == $2* ]] && continue
if git reset $f >/dev/null 2>&1; then
# Reset failed... file was previously unversioned
echo Deleting $f
rm $f
else
echo Reverting $f
git checkout -- $f >/dev/null 2>&1
fi
done
unset IFS
A simple approach for selective merging/committing by file:
git checkout dstBranch
git merge srcBranch
// Make changes, including resolving conflicts to single files
git add singleFile1 singleFile2
git commit -m "message specific to a few files"
git reset --hard # Blow away uncommitted changes
git reset --hard
get rid of committed changes?
If you don't have too many files that have changed, this will leave you with no extra commits.
1. Duplicate branch temporarily
$ git checkout -b temp_branch
2. Reset to last wanted commit
$ git reset --hard HEAD~n
, where n
is the number of commits you need to go back
3. Checkout each file from original branch
$ git checkout origin/original_branch filename.ext
Now you can commit and force push (to overwrite remote), if needed.
If you only need to merge a particular directory and leave everything else intact and yet preserve history, you could possibly try this... create a new target-branch
off of the master
before you experiment.
The steps below assume you have two branches target-branch
and source-branch
, and the directory dir-to-merge
that you want to merge is in the source-branch
. Also assume you have other directories like dir-to-retain
in the target that you don't want to change and retain history. Also, assumes there are merge conflicts in the dir-to-merge
.
git checkout target-branch
git merge --no-ff --no-commit -X theirs source-branch
# the option "-X theirs", will pick theirs when there is a conflict.
# the options "--no--ff --no-commit" prevent a commit after a merge, and give you an opportunity to fix other directories you want to retain, before you commit this merge.
# the above, would have messed up the other directories that you want to retain.
# so you need to reset them for every directory that you want to retain.
git reset HEAD dir-to-retain
# verify everything and commit.
When only a few files have changed between the current commits of the two branches, I manually merge the changes by going through the different files.
git difftool <branch-1>..<branch-2>
see also https://sites.google.com/site/icusite/setup/git-difftool
I'm going to concentrate on the subset of this problem that was of interest to me: I have two branches and I want to pseudo-merge one file from one into the other.
(I say "pseudo-merge" because I don't need or want a merge commit; I just want to combine the contributions of both versions of the file, in the way that I see fit.)
My approach is based on the approach taken in https://stackoverflow.com/a/39916536/341994. Unfortunately that question is closed as a duplicate (wrongly, in my opinion: it's not a duplicate of this question, and it is wrong to answer-and-close-as-duplicate which is what the answerer did there). But there are some things wrong with that answer, so I've modernized and cleaned up the approach. Instead of checkout
and reset
, I use restore
, and I don't bother to commit anything I don't have to.
Okay, so imagine I have three files:
$ ls
a b f
But I only want to pseudo-merge one of them, a
, from otherbranch
. Let's peek at them to see what the situation will look like. Here's my version:
$ cat a
line one
line two
line three
line four
line five
Here's otherbranch's version:
$ git show otherbranch:a
line one
line two edited
line three
line four
line five
line six
Now the trick here is that we're going to use the index as a scratch pad (which is, after all, what it is for). So we start (STEP 1) by making sure that our version is copied into the index:
$ git add a
Now (STEP 2) we can use restore
to fetch the version from otherbranch
(nowadays, restore
is better than checkout
as it lets us talk more clearly):
$ git restore --source otherbranch a
At first blush, this looks bad. We have now completely overwritten our a with the version from otherbranch
, as you can see:
$ cat a
line one
line two edited
line three
line four
line five
line six
But not to worry! The previous version of a is still in the index, as you can see:
$ git diff a
diff --git a/a b/a
index abf51fa..333614b 100644
--- a/a
+++ b/a
@@ -1,6 +1,7 @@
line one
-line two
+line two edited
line three
line four
line five
+line six
Very well, now we're ready for the key move (STEP 3). We do an interactive patch add
of our file from the working tree to the index.
We could say git add -p a
to start the interactive patch process, in which case we are fed hunks one at a time. But in this case there is just one hunk, and I want to edit it anyway, so I say:
$ git add --e a
The result is that we open a patch file of diffs in our editor! It looks like this:
line one
-line two
+line two edited
line three
line four
line five
+line six
By careful editing we can now decide what parts we want to accept and what parts we don't. Let's accept "line six" but not "line two edited". So we edit to look like this:
line one
line two
line three
line four
line five
+line six
We close the editor and the patch is applied to the index version of a. But we are not quite finished! The otherbranch
version of a is still sitting in the working tree:
$ cat a
line one
line two edited
line three
line four
line five
line six
The version we like is in the index, remember? To get it, (STEP 4) we just call git restore
plain and simple (again, this the modern way; restore
is nicer than reset
and can apply to a single file):
$ git restore a
Now our a is correct, and we're all finished:
$ cat a
line one
line two
line three
line four
line five
line six
We could at this point commit, but we don't have to; we've accomplished what we set out to accomplish.
What I want: Interactively pick hunks from a branch (which had several messy commits) into a clean commit in a new branch.
git diff
+ git apply
won't work if you had any binary files in that diff.
My approach:
# New branch from a clean starting point, e.g. master
git checkout new-clean-branch origin/master
# Get all changes from the messy branch
# (quote the star so your shell doesn't expand it)
git checkout messy-branch -- '*'
# Unstage ("un-add") everything
git restore --staged .
# Interactively add hunks to be staged for commit
git add -p
If you are a Gitkraken User here you have a small guide
In summary:
move to the branch which you want to bring the changes. (e.g. develop) right click on the branch that has the new changes and choose the "cherrypick commit" option (e.g. feature-ABC). Finally Accept and check for conflicts if any.
Success story sharing
foo.c
dogit reset HEAD foo.c
to unstage that file and you can then diff it. I found this out after trying it and coming back here to look for an answer to thisgit diff --cached
git checkout -p <revision> -- <path>
will be the same as issuing the first three commands you described :)