man1/git-rerere.1

   1 '\" t
   2 .\"     Title: git-rerere
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 01/03/2022
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.34.1.428.gdcc0cd074f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-RERERE" "1" "01/03/2022" "Git 2\&.34\&.1\&.428\&.gdcc0cd" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-rerere \- Reuse recorded resolution of conflicted merges
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit rerere\fR [\fIclear\fR|\fIforget\fR <pathspec>|\fIdiff\fR|\fIremaining\fR|\fIstatus\fR|\fIgc\fR]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 In a workflow employing relatively long lived topic branches, the developer sometimes needs to resolve the same conflicts over and over again until the topic branches are done (either merged to the "release" branch, or sent out and accepted upstream)\&.
  41 .sp
  42 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\&.
  43 .if n \{\
  44 .sp
  45 .\}
  46 .RS 4
  47 .it 1 an-trap
  48 .nr an-no-space-flag 1
  49 .nr an-break-flag 1
  50 .br
  51 .ps +1
  52 \fBNote\fR
  53 .ps -1
  54 .br
  55 .sp
  56 You need to set the configuration variable \fBrerere\&.enabled\fR in order to enable this command\&.
  57 .sp .5v
  58 .RE
  59 .SH "COMMANDS"
  60 .sp
  61 Normally, \fIgit rerere\fR is run without arguments or user\-intervention\&. However, it has several commands that allow it to interact with its working state\&.
  62 .PP
  63 \fIclear\fR
  64 .RS 4
  65 Reset the metadata used by rerere if a merge resolution is to be aborted\&. Calling
  66 \fIgit am [\-\-skip|\-\-abort]\fR
  67 or
  68 \fIgit rebase [\-\-skip|\-\-abort]\fR
  69 will automatically invoke this command\&.
  70 .RE
  71 .PP
  72 \fIforget\fR <pathspec>
  73 .RS 4
  74 Reset the conflict resolutions which rerere has recorded for the current conflict in <pathspec>\&.
  75 .RE
  76 .PP
  77 \fIdiff\fR
  78 .RS 4
  79 Display diffs for the current state of the resolution\&. It is useful for tracking what has changed while the user is resolving conflicts\&. Additional arguments are passed directly to the system
  80 \fIdiff\fR
  81 command installed in PATH\&.
  82 .RE
  83 .PP
  84 \fIstatus\fR
  85 .RS 4
  86 Print paths with conflicts whose merge resolution rerere will record\&.
  87 .RE
  88 .PP
  89 \fIremaining\fR
  90 .RS 4
  91 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\&.
  92 .RE
  93 .PP
  94 \fIgc\fR
  95 .RS 4
  96 Prune records of conflicted merges that 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
  97 \fBgc\&.rerereUnresolved\fR
  98 and
  99 \fBgc\&.rerereResolved\fR
 100 configuration variables respectively\&.
 101 .RE
 102 .SH "DISCUSSION"
 103 .sp
 104 When your topic branch modifies an overlapping area that your 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:
 105 .sp
 106 .if n \{\
 107 .RS 4
 108 .\}
 109 .nf
 110               o\-\-\-*\-\-\-o topic
 111              /
 112     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o master
 113 .fi
 114 .if n \{\
 115 .RE
 116 .\}
 117 .sp
 118 .sp
 119 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:
 120 .sp
 121 .if n \{\
 122 .RS 4
 123 .\}
 124 .nf
 125         $ git switch topic
 126         $ git merge master
 127
 128               o\-\-\-*\-\-\-o\-\-\-+ topic
 129              /           /
 130     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o master
 131 .fi
 132 .if n \{\
 133 .RE
 134 .\}
 135 .sp
 136 .sp
 137 The commits marked with \fB*\fR touch the same area in the same file; you need to resolve the conflicts when creating the commit marked with \fB+\fR\&. Then you can test the result to make sure your work\-in\-progress still works with what is in the latest master\&.
 138 .sp
 139 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 commit \fB+\fR, and when your work in the topic branch is finally ready, pull the topic branch into master, and/or ask the upstream to pull from you\&. By that time, however, the master or the upstream might have been advanced since the test merge \fB+\fR, in which case the final commit graph would look like this:
 140 .sp
 141 .if n \{\
 142 .RS 4
 143 .\}
 144 .nf
 145         $ git switch topic
 146         $ git merge master
 147         $ \&.\&.\&. work on both topic and master branches
 148         $ git switch master
 149         $ git merge topic
 150
 151               o\-\-\-*\-\-\-o\-\-\-+\-\-\-o\-\-\-o topic
 152              /           /         \e
 153     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-+ master
 154 .fi
 155 .if n \{\
 156 .RE
 157 .\}
 158 .sp
 159 .sp
 160 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"\&.
 161 .sp
 162 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:
 163 .sp
 164 .if n \{\
 165 .RS 4
 166 .\}
 167 .nf
 168         $ git switch topic
 169         $ git merge master
 170         $ git reset \-\-hard HEAD^ ;# rewind the test merge
 171         $ \&.\&.\&. work on both topic and master branches
 172         $ git switch master
 173         $ git merge topic
 174
 175               o\-\-\-*\-\-\-o\-\-\-\-\-\-\-o\-\-\-o topic
 176              /                     \e
 177     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-+ master
 178 .fi
 179 .if n \{\
 180 .RE
 181 .\}
 182 .sp
 183 .sp
 184 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 commits marked with \fB*\fR\&. However, this conflict is often the same conflict you resolved when you created the test merge you blew away\&. \fIgit rerere\fR helps you resolve this final conflicted merge using the information from your earlier hand resolve\&.
 185 .sp
 186 Running the \fIgit rerere\fR command immediately after a conflicted automerge records the conflicted working tree files, with the usual conflict markers \fB<<<<<<<\fR, \fB=======\fR, and \fB>>>>>>>\fR in them\&. Later, after you are done resolving the conflicts, running \fIgit rerere\fR again will record the resolved state of these files\&. Suppose you did this when you created the test merge of master into the topic branch\&.
 187 .sp
 188 Next time, after seeing the same conflicted automerge, running \fIgit rerere\fR will perform a three\-way merge between the earlier conflicted automerge, the earlier manual resolution, and the current conflicted automerge\&. If this three\-way merge resolves cleanly, the result is written out to your working tree file, so you do not have to manually resolve it\&. Note that \fIgit rerere\fR leaves the index file alone, so you still need to do the final sanity checks with \fBgit diff\fR (or \fBgit diff \-c\fR) and \fIgit add\fR when you are satisfied\&.
 189 .sp
 190 As a convenience measure, \fIgit merge\fR automatically invokes \fIgit rerere\fR upon exiting with a failed automerge and \fIgit rerere\fR records the hand resolve when it is a new conflict, or reuses the earlier hand resolve when it is not\&. \fIgit commit\fR also invokes \fIgit rerere\fR 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)\&.
 191 .sp
 192 In our example, when you do the test merge, the manual resolution is recorded, and it will be reused when you do the actual merge later with the updated master and topic branch, as long as the recorded resolution is still applicable\&.
 193 .sp
 194 The information \fIgit rerere\fR records is also used when running \fIgit rebase\fR\&. After blowing away the test merge and continuing development on the topic branch:
 195 .sp
 196 .if n \{\
 197 .RS 4
 198 .\}
 199 .nf
 200               o\-\-\-*\-\-\-o\-\-\-\-\-\-\-o\-\-\-o topic
 201              /
 202     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o\-\-\-o\-\-\-o   master
 203
 204         $ git rebase master topic
 205
 206                                   o\-\-\-*\-\-\-o\-\-\-\-\-\-\-o\-\-\-o topic
 207                                  /
 208     o\-\-\-o\-\-\-o\-\-\-*\-\-\-o\-\-\-o\-\-\-o\-\-\-o   master
 209 .fi
 210 .if n \{\
 211 .RE
 212 .\}
 213 .sp
 214 .sp
 215 you could run \fBgit rebase master topic\fR, 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\&. \fIgit rerere\fR will be run by \fIgit rebase\fR to help you resolve this conflict\&.
 216 .sp
 217 [NOTE] \fIgit rerere\fR relies on the conflict markers in the file to detect the conflict\&. If the file already contains lines that look the same as lines with conflict markers, \fIgit rerere\fR may fail to record a conflict resolution\&. To work around this, the \fBconflict\-marker\-size\fR setting in \fBgitattributes\fR(5) can be used\&.
 218 .SH "GIT"
 219 .sp
 220 Part of the \fBgit\fR(1) suite