Gitのrerereで、同じコンフリクトの解決を使い回す方法

​​Git​コマンドライン

git config rerere.enabled true で rerere を有効にしておくと、手で直したコンフリクトの解決を Git が記録し、同じコンフリクトがもう一度起きたときに、その解決を自動で当ててくれます。マージをやり直したときや、作業ブランチを main の上に何度も rebase するときに、同じ行のコンフリクトを毎回直す手間が減ります。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。コマンドを実行し、操作の前と後の出力をそのまま載せています。Git の表示は英語のまま実行しています。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、コミットの日時は環境変数で決めました。git rebase --continue などでエディターが開かないように、GIT_EDITOR=true を指定しています(メッセージはそのまま使われます)。本文のコマンドでは、これらの指定を省いています。Windows と macOS での動作、GUI のツールやエディターの拡張機能からのマージは試していません。

コンフリクトする2つのブランチ

main から topic ブランチを作り、README の説明の行をそれぞれのブランチで書き換えました。topic では「共有する」、main では「整理する」に変えています。

console
$ git log --oneline --graph --all
* f5bfe2e 説明に整理を足す
| * 0ab4910 説明に共有を足す
|/  
* 14f5210 最初のコミット

rerere.enabled を true にする

最初の状態では、rerere.enabled は設定されておらず、記録を置く .git/rr-cache フォルダもありません。

console
$ git config --get rerere.enabled

$ ls .git/rr-cache
ls: cannot access '.git/rr-cache': No such file or directory

$ git config rerere.enabled true

$ git config --get rerere.enabled
true

ここではこのリポジトリだけで有効にしました。すべてのリポジトリで使うなら git config --global rerere.enabled true にします。rerere.enabled の公式リファレンスによると、この設定がなくても .git/rr-cache があれば rerere は動きます。

1回目:コンフリクトと、手で直した結果が記録される

main で topic をマージすると、いつものコンフリクトの表示に Recorded preimage for 'README.md' の1行が加わりました。公式リファレンスによると、rerere はコンフリクトしたファイルを、マーカーが入った状態のまま記録します。

console
$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Recorded preimage for 'README.md'
Automatic merge failed; fix conflicts and then commit the result.

$ git rerere status
README.md

$ git rerere remaining
README.md

$ cat README.md
# 猫の手アプリ

<<<<<<< HEAD
猫の写真を集めて整理するアプリです。
=======
猫の写真を集めて共有するアプリです。
>>>>>>> topic

$ ls .git/rr-cache
457c4d0b49208351be26b4b55227a794e3407467

$ ls .git/rr-cache/*
preimage

git rerere status は、rerere が解決を記録しようとしているファイルを表示します。git rerere remaining は、rerere で解決できずに残っているファイルを表示します。.git/rr-cache の中には、コンフリクトごとのフォルダができ、そこにコンフリクトした状態(preimage)が保存されていました。

ファイルを書き直したところで git rerere diff を実行すると、記録したコンフリクトから、いまのファイルまでの差分が出ます。

console
$ printf "# 猫の手アプリ\n\n猫の写真を集めて整理・共有するアプリです。\n" > README.md

$ git rerere diff
--- a/README.md
+++ b/README.md
@@ -1,7 +1,3 @@
 # 猫の手アプリ
 
-<<<<<<<
-猫の写真を集めて共有するアプリです。
-=======
-猫の写真を集めて整理するアプリです。
->>>>>>>
+猫の写真を集めて整理・共有するアプリです。

差分の中では、マーカーの後ろのブランチ名がなく、2つの行の順番もファイルと逆になっていました。

git add してコミットすると、今度は Recorded resolution for 'README.md'. と出ました。手で直した結果が postimage として保存されています。

console
$ git add README.md

$ git commit --no-edit
Recorded resolution for 'README.md'.
[main 7b8f8f7] Merge branch 'topic'

$ ls .git/rr-cache/*
postimage
preimage

$ cat .git/rr-cache/*/postimage
# 猫の手アプリ

猫の写真を集めて整理・共有するアプリです。

解決が記録されたのは、コミットしたときでした。git add の時点では何も表示されません。公式リファレンスにも、マージの結果をコミットするときに git commit が rerere を呼び出すと書かれています。

2回目:同じコンフリクトに、記録した解決が当たる

マージのコミットを git reset --hard HEAD~1 で取り消し、もう一度同じマージをしました。

console
$ git reset -q --hard HEAD~1

$ git log --oneline -1
f5bfe2e 説明に整理を足す

$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Resolved 'README.md' using previous resolution.
Automatic merge failed; fix conflicts and then commit the result.

$ cat README.md
# 猫の手アプリ

猫の写真を集めて整理・共有するアプリです。

Resolved 'README.md' using previous resolution. と出て、README.md は1回目に直した内容になっていました。コンフリクトのマーカーはありません。

ただし、Git から見るとまだコンフリクトは終わっていません。git status では both modified のままで、このままコミットしようとするとエラーになりました。

console
$ git status
On branch main
You have unmerged paths.
  (fix conflicts and run "git commit")
  (use "git merge --abort" to abort the merge)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

$ git rerere remaining

$ git commit --no-edit
error: Committing is not possible because you have unmerged files.
hint: Fix them up in the work tree, and then use 'git add/rm <file>'
hint: as appropriate to mark resolution and make a commit.
fatal: Exiting because of an unresolved conflict.
U	README.md

$ git diff
diff --cc README.md
index 159267f,1e002c9..0000000
--- a/README.md
+++ b/README.md
@@@ -1,3 -1,3 +1,3 @@@
  # 猫の手アプリ
  
- 猫の写真を集めて整理するアプリです。
 -猫の写真を集めて共有するアプリです。
++猫の写真を集めて整理・共有するアプリです。

$ git add README.md

$ git commit -q --no-edit

git rerere remaining は、1回目は README.md を表示しましたが、2回目は何も出しませんでした。git diff を見ると、両方のブランチの行が、記録した1行に置き換わっています。git rerere の公式リファレンスにも、rerere はインデックスには手を付けないので、最後に git diff で確かめてから git add するよう書かれています。

rebase でも、同じ解決が使われる

もう一度マージを取り消し、今度は topic に移って main の上に rebase しました。

console
$ git reset -q --hard HEAD~1

$ git switch topic
Switched to branch 'topic'

$ git rebase main
Rebasing (1/1)
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
error: could not apply 0ab4910... 説明に共有を足す
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Resolved 'README.md' using previous resolution.
Could not apply 0ab4910... 説明に共有を足す

$ cat README.md
# 猫の手アプリ

猫の写真を集めて整理・共有するアプリです。

マージのときに記録した解決が、rebase でも当てられました。git rerere の公式リファレンスにも、rerere の記録は git rebase のときにも使われると書かれています。あとは普通の rebase と同じく、git add してから git rebase --continue で続けます。

console
$ git add README.md

$ git rebase --continue
[detached HEAD 9152954] 説明に共有を足す
 1 file changed, 1 insertion(+), 1 deletion(-)

Successfully rebased and updated refs/heads/topic.

$ git log --oneline --graph
* 9152954 説明に共有を足す
* f5bfe2e 説明に整理を足す
* 14f5210 最初のコミット

git rerere の公式リファレンスでは、長く使う作業ブランチで、その作業ブランチを取り込み終えるまで同じコンフリクトを何度も直す場面のための機能だと説明されています。リファレンスの例には、試しにマージしてコンフリクトを直し、git reset --hard HEAD^ で取り消しておき、あとで本番のマージをするときに記録した解決を使う流れが載っています。

rerere.autoUpdate で git add まで自動にする

rebase を取り消して topic を元に戻してから、rerere.autoUpdate を true にして、main でもう一度マージしました。

console
$ git reset -q --hard ORIG_HEAD

$ git log --oneline -1
0ab4910 説明に共有を足す

$ git switch -q main

$ git config rerere.autoUpdate true

$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Staged 'README.md' using previous resolution.
Automatic merge failed; fix conflicts and then commit the result.

$ git status
On branch main
All conflicts fixed but you are still merging.
  (use "git commit" to conclude merge)

Changes to be committed:
	modified:   README.md

$ git diff --cached
diff --git a/README.md b/README.md
index 159267f..a89e90d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,3 @@
 # 猫の手アプリ
 
-猫の写真を集めて整理するアプリです。
+猫の写真を集めて整理・共有するアプリです。

表示が Staged 'README.md' using previous resolution. に変わり、git status は「All conflicts fixed」になりました。記録した解決でステージ(git add)まで済んだので、あとは git commit するだけです。rerere.autoUpdate の公式リファレンスにあるとおり、既定は false です。

注意

rerere は、前に記録した解決が正しいかどうかは確かめずに当てます。1回目の直し方が間違っていると、同じ間違いが何度でも入ります。rerere.autoUpdate を有効にすると git add の手順もなくなるので、コミットの前に git diff --cached で中身を確かめてください。

間違えて記録した解決を git rerere forget で消す

記録した解決を直したいときは、同じコンフリクトが起きている間に git rerere forget <ファイル> を実行します。ここでは、いったんマージをやめて rerere.autoUpdate を外してから、もう一度マージしました。

console
$ git merge --abort

$ git config --unset rerere.autoUpdate

$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Resolved 'README.md' using previous resolution.
Automatic merge failed; fix conflicts and then commit the result.

$ cat README.md
# 猫の手アプリ

猫の写真を集めて整理・共有するアプリです。

$ git rerere forget README.md
Updated preimage for 'README.md'
Forgot resolution for 'README.md'

$ cat README.md
# 猫の手アプリ

猫の写真を集めて整理・共有するアプリです。

Forgot resolution と出て記録は消えましたが、作業ツリーの README.md は前の解決が当たったままでした。コンフリクトの状態からやり直すには、git checkout -m README.md でマーカー付きの内容に戻します。

console
$ git checkout -m README.md
Recreated 1 merge conflict

$ cat README.md
# 猫の手アプリ

<<<<<<< ours
猫の写真を集めて整理するアプリです。
=======
猫の写真を集めて共有するアプリです。
>>>>>>> theirs

戻したマーカーの名前は、ブランチ名ではなく ours と theirs になっていました。ここからもう一度直してコミットすると、新しい解決が記録されます。

console
$ printf "# 猫の手アプリ\n\n猫の写真を集めて整理し、共有するアプリです。\n" > README.md

$ git add README.md

$ git commit --no-edit
Recorded resolution for 'README.md'.
[main cd0e5f2] Merge branch 'topic'

$ cat .git/rr-cache/*/postimage
# 猫の手アプリ

猫の写真を集めて整理し、共有するアプリです。

このマージを取り消してもう一度マージすると、新しい「整理し、共有する」の内容が当たりました。

console
$ git reset -q --hard HEAD~1

$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Resolved 'README.md' using previous resolution.
Automatic merge failed; fix conflicts and then commit the result.

$ cat README.md
# 猫の手アプリ

猫の写真を集めて整理し、共有するアプリです。

中身が違うコンフリクトには当たらない

git merge --abort でマージをやめ、topic の行を「家族と共有する」に書き換えてから、もう一度マージしました。同じ行でのコンフリクトですが、ぶつかる中身が変わったので、記録した解決は使われず、新しいコンフリクトとして記録されました。

console
$ git merge --abort

$ git switch -q topic

$ printf "# 猫の手アプリ\n\n猫の写真を集めて家族と共有するアプリです。\n" > README.md

$ git commit -q -am "共有の相手を書く"

$ git switch -q main

$ git merge topic
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Recorded preimage for 'README.md'
Automatic merge failed; fix conflicts and then commit the result.

$ cat README.md
# 猫の手アプリ

<<<<<<< HEAD
猫の写真を集めて整理するアプリです。
=======
猫の写真を集めて家族と共有するアプリです。
>>>>>>> topic

$ ls .git/rr-cache
457c4d0b49208351be26b4b55227a794e3407467
6809b905bef68e684f17668c5ff022fb9af3a0a2

.git/rr-cache のフォルダが2つに増えています。rerere.enabled の説明にも、自動で解決されるのは同じ内容のコンフリクトだと書かれています。

記録はいつ消えるか

ここでは新しいコンフリクトを直さずに git merge --abort でやめました。そのコンフリクトのフォルダには、preimage だけが残っています。解決を記録した最初のフォルダには、preimage と postimage のほかに thisimage というファイルもできていました。

console
$ ls .git/rr-cache/*
.git/rr-cache/457c4d0b49208351be26b4b55227a794e3407467:
postimage
preimage
thisimage

.git/rr-cache/6809b905bef68e684f17668c5ff022fb9af3a0a2:
preimage

$ git rerere gc

$ ls .git/rr-cache
457c4d0b49208351be26b4b55227a794e3407467
6809b905bef68e684f17668c5ff022fb9af3a0a2

git rerere gc は古い記録を消すコマンドです。作ったばかりの記録なので、実行しても2つとも残りました。公式リファレンスによると、既定では、解決していない記録は15日、解決した記録は60日より古いものが消されます。日数は gc.rerereUnresolved と gc.rerereResolved で変えられます。git gc の公式リファレンスにも、片付けの対象として rerere の記録が挙がっています。

​Posted by 86