7.9 Git 工具 - Rerere

Rerere

git rerere 功能是一个隐藏的功能。 正如它的名字“重用记录的解决方案(reuse recorded resolution)”所示,它允许你让 Git 记住解决一个块冲突的方法, 这样在下一次看到相同冲突时,Git 可以为你自动地解决它。

有几种情形下这个功能会非常有用。 在文档中提到的一个例子是想要保证一个长期分支会干净地合并,但是又不想要一串中间的合并提交弄乱你的提交历史。 将 rerere 功能开启后,你可以试着偶尔合并,解决冲突,然后退出合并。 如果你持续这样做,那么最终的合并会很容易,因为 rerere 可以为你自动做所有的事情。

可以将同样的策略用在维持一个变基的分支时,这样就不用每次解决同样的变基冲突了。 或者你将一个分支合并并修复了一堆冲突后想要用变基来替代合并——你可能并不想要再次解决相同的冲突。

另一个 rerere 的应用场景是当你偶尔将一堆正在改进的主题分支合并到一个可测试的头时,就像 Git 项目自身经常做的。 如果测试失败,你可以倒回合并之前然后在去除导致测试失败的那个主题分支后重做合并,而不用再次重新解决所有的冲突。

要启用 rerere 功能,只需运行以下配置选项即可:

  1. $ git config --global rerere.enabled true

你也可以通过在特定的仓库中创建 .git/rr-cache 目录来开启它,但是设置选项更干净并且可以应用到全局。

现在我们看一个简单的例子,类似之前的那个。 假设有一个名为 hello.rb 的文件如下:

  1. #! /usr/bin/env ruby
  2. def hello
  3. puts 'hello world'
  4. end

在一个分支中修改单词 “hello” 为 “hola”,然后在另一个分支中修改 “world” 为 “mundo”,就像之前一样。

rerere1

当合并两个分支到一起时,我们将会得到一个合并冲突:

  1. $ git merge i18n-world
  2. Auto-merging hello.rb
  3. CONFLICT (content): Merge conflict in hello.rb
  4. Recorded preimage for 'hello.rb'
  5. Automatic merge failed; fix conflicts and then commit the result.

你会注意到那个新行 Recorded preimage for FILE。 除此之外它应该看起来就像一个普通的合并冲突。 在这个时候,rerere 可以告诉我们几件事。 和往常一样,在这个时候你可以运行 git status 来查看所有冲突的内容:

  1. $ git status
  2. # On branch master
  3. # Unmerged paths:
  4. # (use "git reset HEAD <file>..." to unstage)
  5. # (use "git add <file>..." to mark resolution)
  6. #
  7. # both modified: hello.rb
  8. #

然而,git rerere 也会通过 git rerere status 告诉你它记录的合并前状态。

  1. $ git rerere status
  2. hello.rb

并且 git rerere diff 将会显示解决方案的当前状态——开始解决前与解决后的样子。

  1. $ git rerere diff
  2. --- a/hello.rb
  3. +++ b/hello.rb
  4. @@ -1,11 +1,11 @@
  5. #! /usr/bin/env ruby
  6. def hello
  7. -<<<<<<<
  8. - puts 'hello mundo'
  9. -=======
  10. +<<<<<<< HEAD
  11. puts 'hola world'
  12. ->>>>>>>
  13. +=======
  14. + puts 'hello mundo'
  15. +>>>>>>> i18n-world
  16. end

同样(这并不是真的与 rerere 有关系),可以使用 git ls-files -u 来查看冲突文件的之前、左边与右边版本:

  1. $ git ls-files -u
  2. 100644 39804c942a9c1f2c03dc7c5ebcd7f3e3a6b97519 1 hello.rb
  3. 100644 a440db6e8d1fd76ad438a49025a9ad9ce746f581 2 hello.rb
  4. 100644 54336ba847c3758ab604876419607e9443848474 3 hello.rb

现在可以通过改为 puts 'hola mundo' 来解决它,可以再次运行 git rerere diff 命令来查看 rerere 将会记住的内容:

  1. $ git rerere diff
  2. --- a/hello.rb
  3. +++ b/hello.rb
  4. @@ -1,11 +1,7 @@
  5. #! /usr/bin/env ruby
  6. def hello
  7. -<<<<<<<
  8. - puts 'hello mundo'
  9. -=======
  10. - puts 'hola world'
  11. ->>>>>>>
  12. + puts 'hola mundo'
  13. end

所以从本质上说,当 Git 看到一个 hello.rb 文件的一个块冲突中有 “hello mundo” 在一边与 “hola world” 在另一边,它会将其解决为 “hola mundo”。

现在我们可以将它标记为已解决并提交它:

  1. $ git add hello.rb
  2. $ git commit
  3. Recorded resolution for 'hello.rb'.
  4. [master 68e16e5] Merge branch 'i18n'

可以看到它 "Recorded resolution for FILE"。

rerere2

现在,让我们撤消那个合并然后将它变基到 master 分支顶部来替代它。 可以通过使用之前在 重置揭密 看到的 git reset 来回滚分支。

  1. $ git reset --hard HEAD^
  2. HEAD is now at ad63f15 i18n the hello

我们的合并被撤消了。 现在让我们变基主题分支。

  1. $ git checkout i18n-world
  2. Switched to branch 'i18n-world'
  3. $ git rebase master
  4. First, rewinding head to replay your work on top of it...
  5. Applying: i18n one word
  6. Using index info to reconstruct a base tree...
  7. Falling back to patching base and 3-way merge...
  8. Auto-merging hello.rb
  9. CONFLICT (content): Merge conflict in hello.rb
  10. Resolved 'hello.rb' using previous resolution.
  11. Failed to merge in the changes.
  12. Patch failed at 0001 i18n one word

现在,正像我们期望的一样,得到了相同的合并冲突,但是看一下 Resolved FILE using previous resolution 这行。 如果我们看这个文件,会发现它已经被解决了,而且在它里面没有合并冲突标记。

  1. #! /usr/bin/env ruby
  2. def hello
  3. puts 'hola mundo'
  4. end

同样,git diff 将会显示出它是如何自动地重新解决的:

  1. $ git diff
  2. diff --cc hello.rb
  3. index a440db6,54336ba..0000000
  4. --- a/hello.rb
  5. +++ b/hello.rb
  6. @@@ -1,7 -1,7 +1,7 @@@
  7. #! /usr/bin/env ruby
  8. def hello
  9. - puts 'hola world'
  10. - puts 'hello mundo'
  11. ++ puts 'hola mundo'
  12. end

rerere3

也可以通过 git checkout 命令重新恢复到冲突时候的文件状态:

  1. $ git checkout --conflict=merge hello.rb
  2. $ cat hello.rb
  3. #! /usr/bin/env ruby
  4. def hello
  5. <<<<<<< ours
  6. puts 'hola world'
  7. =======
  8. puts 'hello mundo'
  9. >>>>>>> theirs
  10. end

我们将会在 高级合并 中看到这个的一个例子。 然而现在,让我们通过运行 git rerere 来重新解决它:

  1. $ git rerere
  2. Resolved 'hello.rb' using previous resolution.
  3. $ cat hello.rb
  4. #! /usr/bin/env ruby
  5. def hello
  6. puts 'hola mundo'
  7. end

我们通过 rerere 缓存的解决方案来自动重新解决了文件冲突。 现在可以添加并继续变基来完成它。

  1. $ git add hello.rb
  2. $ git rebase --continue
  3. Applying: i18n one word

所以,如果做了很多次重新合并,或者想要一个主题分支始终与你的 master 分支保持最新但却不想要一大堆合并, 或者经常变基,打开 rerere 功能可以帮助你的生活变得更美好。