git-rerere.txt 7.29 KB
Newer Older
1 2 3 4 5
git-rerere(1)
=============

NAME
----
6
git-rerere - Reuse recorded resolution of conflicted merges
7 8 9

SYNOPSIS
--------
10
[verse]
11
'git rerere' ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
12 13 14 15

DESCRIPTION
-----------

16 17
In a workflow employing relatively long lived topic branches,
the developer sometimes needs to resolve the same conflicts over
18 19 20
and over again until the topic branches are done (either merged
to the "release" branch, or sent out and accepted upstream).

21 22 23 24
This command assists the developer in this process by recording
conflicted automerge results and corresponding hand resolve results
on the initial manual merge, and applying previously recorded
hand resolutions to their corresponding automerge results.
25

26
[NOTE]
27
You need to set the configuration variable rerere.enabled in order to
28 29
enable this command.

30 31 32 33

COMMANDS
--------

34
Normally, 'git rerere' is run without arguments or user-intervention.
35 36 37 38 39
However, it has several commands that allow it to interact with
its working state.

'clear'::

40
Reset the metadata used by rerere if a merge resolution is to be
41
aborted.  Calling 'git am [--skip|--abort]' or 'git rebase [--skip|--abort]'
42
will automatically invoke this command.
43

44 45
'forget' <pathspec>::

46
Reset the conflict resolutions which rerere has recorded for the current
47
conflict in <pathspec>.
48

49 50
'diff'::

51
Display diffs for the current state of the resolution.  It is
52 53
useful for tracking what has changed while the user is resolving
conflicts.  Additional arguments are passed directly to the system
54
'diff' command installed in PATH.
55 56 57

'status'::

58 59 60 61 62 63 64
Print paths with conflicts whose merge resolution rerere will record.

'remaining'::

Print paths with conflicts that have not been autoresolved by rerere.
This includes paths whose resolutions cannot be tracked by rerere,
such as conflicting submodules.
65 66 67

'gc'::

68
Prune records of conflicted merges that
69 70 71
occurred a long time ago.  By default, unresolved conflicts older
than 15 days and resolved conflicts older than 60
days are pruned.  These defaults are controlled via the
72
`gc.rerereunresolved` and `gc.rerereresolved` configuration
73
variables respectively.
74 75


76 77 78
DISCUSSION
----------

79
When your topic branch modifies an overlapping area that your
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
master branch (or upstream) touched since your topic branch
forked from it, you may want to test it with the latest master,
even before your topic branch is ready to be pushed upstream:

------------
              o---*---o topic
             /
    o---o---o---*---o---o master
------------

For such a test, you need to merge master and topic somehow.
One way to do it is to pull master into the topic branch:

------------
	$ git checkout topic
Nicolas Pitre's avatar
Nicolas Pitre committed
95
	$ git merge master
96 97 98 99 100 101 102 103

              o---*---o---+ topic
             /           /
    o---o---o---*---o---o master
------------

The commits marked with `*` touch the same area in the same
file; you need to resolve the conflicts when creating the commit
104
marked with `+`.  Then you can test the result to make sure your
105 106 107 108
work-in-progress still works with what is in the latest master.

After this test merge, there are two ways to continue your work
on the topic.  The easiest is to build on top of the test merge
109
commit `+`, and when your work in the topic branch is finally
110 111
ready, pull the topic branch into master, and/or ask the
upstream to pull from you.  By that time, however, the master or
112
the upstream might have been advanced since the test merge `+`,
113 114 115 116
in which case the final commit graph would look like this:

------------
	$ git checkout topic
Nicolas Pitre's avatar
Nicolas Pitre committed
117
	$ git merge master
118 119
	$ ... work on both topic and master branches
	$ git checkout master
Nicolas Pitre's avatar
Nicolas Pitre committed
120
	$ git merge topic
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

              o---*---o---+---o---o topic
             /           /         \
    o---o---o---*---o---o---o---o---+ master
------------

When your topic branch is long-lived, however, your topic branch
would end up having many such "Merge from master" commits on it,
which would unnecessarily clutter the development history.
Readers of the Linux kernel mailing list may remember that Linus
complained about such too frequent test merges when a subsystem
maintainer asked to pull from a branch full of "useless merges".

As an alternative, to keep the topic branch clean of test
merges, you could blow away the test merge, and keep building on
top of the tip before the test merge:

------------
	$ git checkout topic
Nicolas Pitre's avatar
Nicolas Pitre committed
140
	$ git merge master
141 142 143
	$ git reset --hard HEAD^ ;# rewind the test merge
	$ ... work on both topic and master branches
	$ git checkout master
Nicolas Pitre's avatar
Nicolas Pitre committed
144
	$ git merge topic
145 146 147 148 149 150 151 152 153

              o---*---o-------o---o topic
             /                     \
    o---o---o---*---o---o---o---o---+ master
------------

This would leave only one merge commit when your topic branch is
finally ready and merged into the master branch.  This merge
would require you to resolve the conflict, introduced by the
154
commits marked with `*`.  However, this conflict is often the
155
same conflict you resolved when you created the test merge you
156
blew away.  'git rerere' helps you resolve this final
157 158 159
conflicted merge using the information from your earlier hand
resolve.

160
Running the 'git rerere' command immediately after a conflicted
161 162 163
automerge records the conflicted working tree files, with the
usual conflict markers `<<<<<<<`, `=======`, and `>>>>>>>` in
them.  Later, after you are done resolving the conflicts,
164
running 'git rerere' again will record the resolved state of these
165 166 167
files.  Suppose you did this when you created the test merge of
master into the topic branch.

168
Next time, after seeing the same conflicted automerge,
169
running 'git rerere' will perform a three-way merge between the
170
earlier conflicted automerge, the earlier manual resolution, and
171
the current conflicted automerge.
172
If this three-way merge resolves cleanly, the result is written
173
out to your working tree file, so you do not have to manually
174
resolve it.  Note that 'git rerere' leaves the index file alone,
175
so you still need to do the final sanity checks with `git diff`
176
(or `git diff -c`) and 'git add' when you are satisfied.
177

178 179
As a convenience measure, 'git merge' automatically invokes
'git rerere' upon exiting with a failed automerge and 'git rerere'
180
records the hand resolve when it is a new conflict, or reuses the earlier hand
181
resolve when it is not.  'git commit' also invokes 'git rerere'
182 183 184
when committing a merge result.  What this means is that you do
not have to do anything special yourself (besides enabling
the rerere.enabled config variable).
185

186
In our example, when you do the test merge, the manual
187
resolution is recorded, and it will be reused when you do the
188 189
actual merge later with the updated master and topic branch, as long
as the recorded resolution is still applicable.
190

191 192
The information 'git rerere' records is also used when running
'git rebase'.  After blowing away the test merge and continuing
193 194 195 196 197 198 199 200 201 202 203 204 205 206
development on the topic branch:

------------
              o---*---o-------o---o topic
             /
    o---o---o---*---o---o---o---o   master

	$ git rebase master topic

				  o---*---o-------o---o topic
				 /
    o---o---o---*---o---o---o---o   master
------------

207 208 209 210
you could run `git rebase master topic`, to bring yourself
up-to-date before your topic is ready to be sent upstream.
This would result in falling back to a three-way merge, and it
would conflict the same way as the test merge you resolved earlier.
211
'git rerere' will be run by 'git rebase' to help you resolve this
212 213 214 215
conflict.

GIT
---
216
Part of the linkgit:git[1] suite