git cherry-pick的使用小结
git cherry-pick
可以理解为”挑拣”提交,它会获取某一个分支的单笔提交,并作为一个新的提交引入到你当前分支上。 当我们需要在本地合入其他分支的提交时,如果我们不想对整个分支进行合并,而是只想将某一次提交合入到本地当前分支上,那么就要使用git cherry-pick
了。
用法
git cherry-pick [<options>] <commit-ish>...
常用options:
--quit 退出当前的chery-pick序列
--continue 继续当前的chery-pick序列
--abort 取消当前的chery-pick序列,恢复当前分支
-n, --no-commit 不自动提交
-e, --edit 编辑提交信息
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
git cherry-pick commitid
在本地仓库中,有两个分支:branch1和branch2,我们先来查看各个分支的提交:
# 切换到branch2分支
$ git checkout branch2
Switched to branch 'branch2'
$
$
# 查看最近三次提交
$ git log --oneline -3
23d9422 [Description]:branch2 commit 3
2555c6e [Description]:branch2 commit 2
b82ba0f [Description]:branch2 commit 1
# 切换到branch1分支
$ git checkout branch1
Switched to branch 'branch1'
# 查看最近三次提交
$ git log --oneline -3
20fe2f9 commit second
c51adbe commit first
ae2bd14 commit 3th
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
现在,我想要将branch2分支上的第一次提交内容合入到branch1分支上,则可以使用git cherry-pick
命令:
$ git cherry-pick 2555c6e
error: could not apply 2555c6e... [Description]:branch2 commit 2
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'
- 1
- 2
- 3
- 4
- 5
- 6
当cherry-pick
时,没有成功自动提交,这说明存在冲突,因此首先需要解决冲突,解决冲突后需要git commit
手动进行提交:
$ git commit
[branch1 790f431] [Description]:branch2 commit 2
Date: Fri Jul 13 18:36:44 2018 +0800
1 file changed, 1 insertion(+)
create mode 100644 only-for-branch2.txt
- 1
- 2
- 3
- 4
- 5
- 6
或者git add .
后直接使用git cherry-pick --continue
继续。
现在查看提交信息:
$ git log --oneline -3
790f431 [Description]:branch2 commit 2
20fe2f9 commit second
c51adbe commit first
- 1
- 2
- 3
- 4
- 5
branch2分支上的第二次提交成功合入到了branch1分支上。
以上就是git cherry-pick
的基本用法,如果没有出现冲突,该命令将自动提交。
git cherry-pick -n
如果不想git cherry-pick
自动进行提交,则加参数-n
即可。比如将branch2分支上的第三次提交内容合入到branch1分支上:
$ git cherry-pick 23d9422
[branch1 2c67715] [Description]:branch2 commit 3
Date: Fri Jul 13 18:37:05 2018 +0800
1 file changed, 1 insertion(+)
$
- 1
- 2
- 3
- 4
- 5
- 6
查看提交log,它自动合入了branch1分支:
$ git log --oneline -3
2c67715 [Description]:branch2 commit 3
f8bc5db [Description]:branch2 commit 2
20fe2f9 commit second
- 1
- 2
- 3
- 4
- 5
如果不想进行自动合入,则使用git cherry-pick -n
:
# 回退上次提交,再此进行cherry-pick
$ git reset --hard HEAD~
HEAD is now at f8bc5db [Description]:branch2 commit 2
$ git cherry-pick -n 23d9422
$ git status
On branch branch1
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)
modified: only-for-branch2.txt
$
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
这时通过git status
查看,发现已将branch2的提交获取但是没有合入。
git cherry-pick -e
如果想要在cherr-pick
后重新编辑提交信息,则使用git cherry-pick -e
命令,比如我们还是要将branch2分支上的第三次提交内容合入到branch1分支上,但是需要修改提交信息:
$ git cherry-pick -e 23d9422
1 [Description]:branch2 commit 3
2 #
3 # It looks like you may be committing a cherry-pick.
4 # If this is not correct, please remove the file
5 # .git/CHERRY_PICK_HEAD
6 # and try again.
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
git cherry-pick –continue, –abort,–quit
当使用git cherry-pick
发生冲突后,将会出现如下信息:
$ git cherry-pick 23d9422
error: could not apply 23d9422... [Description]:branch2 commit 3
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'
- 1
- 2
- 3
- 4
- 5
这时如果要继续cherry-pick,则首先需要解决冲突,通过git add .
将文件标记为已解决,然后可以使用git cherry-pick --continue
命令,继续进行cherry-pick
操作。
如果要中断这次cherry-pick
,则使用git cherry-pick --quit
,这种情况下当前分支中未冲突的内容状态将为modified
,
如果要取消这次cherry-pick
,则使用git cherry-pick --abort
,这种情况下当前分支恢复到cherry-pick
前的状态,没有改变。
git cherry-pick < branchname >
如果在git cherry-pick
后加一个分支名,则表示将该分支顶端提交进cherry-pick,如:
$ git cherry-pick master
- 1
git cherry-pick ..< branchname >
git cherry-pick ^HEAD < branchname >
以上两个命令作用相同,表示应用所有提交引入的更改,这些提交是branchname的祖先但不是HEAD的祖先,比如,现在我的仓库中有三个分支,其提交历史如下图:
C<---D<---E branch2
/
master A<---B
\
F<---G<---H branch3
|
HEAD
- 1
- 2
- 3
- 4
- 5
- 6
- 7
如果我使用git cherry-pick ..branch2
或者git cherry-pick ^HEAD branch2
,那么会将属于branch2的祖先但不属于branch3的祖先的所有提交引入到当前分支branch3上,并生成新的提交,执行命令如下:
$ git cherry-pick ..branch2
[branch3 c95d8b0] [Description]:branch2 add only-for-branch2
Date: Fri Jul 13 20:34:40 2018 +0800
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 only-for-branch2
[branch3 7199a67] [Description]:branch2 modify for only-for-branch2--1
Date: Fri Jul 13 20:38:35 2018 +0800
1 file changed, 1 insertion(+)
[branch3 eb8ab62] [Description]:branch2 modify for only-for-branch2--2
Date: Fri Jul 13 20:39:09 2018 +0800
1 file changed, 1 insertion(+)
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
执行后的提交历史如下:
C<---D<---E branch2
/
master A<---B
\
F<---G<---H<---C'<---D'<---E' branch3
|
HEAD
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
常见问题
1.The previous cherry-pick is now empty, possibly due to conflict resolution.
原因:
在cherry-pick
时出现冲突,解决冲突后本地分支中内容和cherry-pick
之前相比没有改变,因此当在以后的步骤中继续git cherry-pick
或执行其他命令时,由于此时还处于上次cherry-pick
,都会提示该信息,表示可能是由于解决冲突造成上一次cherry-pick内容是空的。
解决方案:
-
1.执行
git cherry-pick --abort
取消上次操作。 -
2.执行
git commit --allow-empty
,表示允许空提交。
2.fatal: You are in the middle of a cherry-pick – cannot amend.
原因:
在cherry-pick
时出现冲突,没有解决冲突就执行git commit --amend
命令,从而会提示该信息。
解决方案:
首先在git commit --amend
之前解决冲突,并完成这次cherry-pick
:
$ git add . $ git cherry-pick --continue
git cherry-pick可以选择某一个分支中的一个或几个commit(s)来进行操作。例如,假设我们有个稳定版本的分支,叫v2.0,另外还有个开发版本的分支v3.0,我们不能直接把两个分支合并,这样会导致稳定版本混乱,但是又想增加一个v3.0中的功能到v2.0中,这里就可以使用cherry-pick了。
就是对已经存在的commit 进行 再次提交;
简单用法:
git cherry-pick <commit id>
注意:当执行完 cherry-pick 以后,将会 生成一个新的提交;这个新的提交的哈希值和原来的不同,但标识名 一样;
例如:
$ git checkout old_cc
$ git cherry-pick 38361a68 # 这个 38361a68 号码,位于:
$ git log
commit 38361a68138140827b31b72f8bbfd88b3705d77a
Author: Siwei Shen <siwei.shen@focusbeijing.com>
Date: Sat Dec 10 00:09:44 2011 +0800
1. 如果顺利,就会正常提交。结果:
Finished one cherry-pick.
# On branch old_cc
# Your branch is ahead of 'origin/old_cc' by 3 commits.
2. 如果在cherry-pick 的过程中出现了冲突
Automatic cherry-pick failed. After resolving the conflicts,
mark the corrected paths with 'git add <paths>' or 'git rm <paths>'
and commit the result with:
git commit -c 15a2b6c61927e5aed6718de89ad9dafba939a90b
就跟普通的冲突一样,手工解决:
2.1 $ git status # 看哪些文件出现冲突
both modified: app/models/user.rb
2.2 $ vim app/models/user.rb # 手动解决它。
2.3 $ git add app/models/user.rb
2.4 git commit -c <新的commit号码>