]>
Commit | Line | Data |
---|---|---|
0f69be53 JH |
1 | git-merge(1) |
2 | ============ | |
0f69be53 JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-merge - Join two or more development histories together |
0f69be53 JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
17bcdad3 | 11 | [verse] |
f8246281 | 12 | 'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit] |
340f2c5e | 13 | [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]] |
09c2cb87 | 14 | [--[no-]allow-unrelated-histories] |
920f22e6 | 15 | [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...] |
35d2fffd | 16 | 'git merge' --abort |
367ff694 | 17 | 'git merge' --continue |
0f69be53 JH |
18 | |
19 | DESCRIPTION | |
20 | ----------- | |
b40bb374 JN |
21 | Incorporates changes from the named commits (since the time their |
22 | histories diverged from the current branch) into the current | |
23 | branch. This command is used by 'git pull' to incorporate changes | |
24 | from another repository and can be used by hand to merge changes | |
25 | from one branch into another. | |
26 | ||
27 | Assume the following history exists and the current branch is | |
28 | "`master`": | |
29 | ||
30 | ------------ | |
31 | A---B---C topic | |
32 | / | |
33 | D---E---F---G master | |
34 | ------------ | |
35 | ||
36 | Then "`git merge topic`" will replay the changes made on the | |
37 | `topic` branch since it diverged from `master` (i.e., `E`) until | |
38 | its current commit (`C`) on top of `master`, and record the result | |
39 | in a new commit along with the names of the two parent commits and | |
40 | a log message from the user describing the changes. | |
41 | ||
42 | ------------ | |
43 | A---B---C topic | |
44 | / \ | |
45 | D---E---F---G---H master | |
46 | ------------ | |
0f69be53 | 47 | |
b4391657 | 48 | The second syntax ("`git merge --abort`") can only be run after the |
35d2fffd JH |
49 | merge has resulted in conflicts. 'git merge --abort' will abort the |
50 | merge process and try to reconstruct the pre-merge state. However, | |
51 | if there were uncommitted changes when the merge started (and | |
52 | especially if those changes were further modified after the merge | |
53 | was started), 'git merge --abort' will in some cases be unable to | |
54 | reconstruct the original (pre-merge) changes. Therefore: | |
55 | ||
76b80cdf MM |
56 | *Warning*: Running 'git merge' with non-trivial uncommitted changes is |
57 | discouraged: while possible, it may leave you in a state that is hard to | |
e330d8ca | 58 | back out of in the case of a conflict. |
dee48c3c | 59 | |
28cb0602 | 60 | The third syntax ("`git merge --continue`") can only be run after the |
367ff694 | 61 | merge has resulted in conflicts. |
0f69be53 JH |
62 | |
63 | OPTIONS | |
64 | ------- | |
93d69d86 | 65 | include::merge-options.txt[] |
0f69be53 | 66 | |
dee48c3c | 67 | -m <msg>:: |
0f8a02c6 | 68 | Set the commit message to be used for the merge commit (in |
f0ecac2b | 69 | case one is created). |
af77aee9 NP |
70 | + |
71 | If `--log` is specified, a shortlog of the commits being merged | |
72 | will be appended to the specified message. | |
73 | + | |
74 | The 'git fmt-merge-msg' command can be | |
75 | used to give a good default for automated 'git merge' | |
561d2b79 | 76 | invocations. The automated message can include the branch description. |
3c64314c | 77 | |
920f22e6 JS |
78 | -F <file>:: |
79 | --file=<file>:: | |
80 | Read the commit message to be used for the merge commit (in | |
81 | case one is created). | |
82 | + | |
83 | If `--log` is specified, a shortlog of the commits being merged | |
84 | will be appended to the specified message. | |
85 | ||
15c6dbd8 PW |
86 | --rerere-autoupdate:: |
87 | --no-rerere-autoupdate:: | |
cb6020bb JH |
88 | Allow the rerere mechanism to update the index with the |
89 | result of auto-conflict resolution if possible. | |
90 | ||
35d2fffd JH |
91 | --abort:: |
92 | Abort the current conflict resolution process, and | |
93 | try to reconstruct the pre-merge state. | |
94 | + | |
95 | If there were uncommitted worktree changes present when the merge | |
96 | started, 'git merge --abort' will in some cases be unable to | |
97 | reconstruct these changes. It is therefore recommended to always | |
98 | commit or stash your changes before running 'git merge'. | |
99 | + | |
100 | 'git merge --abort' is equivalent to 'git reset --merge' when | |
101 | `MERGE_HEAD` is present. | |
102 | ||
f3f8311e NTND |
103 | --quit:: |
104 | Forget about the current merge in progress. Leave the index | |
105 | and the working tree as-is. | |
106 | ||
367ff694 CP |
107 | --continue:: |
108 | After a 'git merge' stops due to conflicts you can conclude the | |
109 | merge by running 'git merge --continue' (see "HOW TO RESOLVE | |
110 | CONFLICTS" section below). | |
111 | ||
57bddb11 TR |
112 | <commit>...:: |
113 | Commits, usually other branch heads, to merge into our branch. | |
93e535a5 JH |
114 | Specifying more than one commit will create a merge with |
115 | more than two parents (affectionately called an Octopus merge). | |
116 | + | |
a01f7f2b FC |
117 | If no commit is given from the command line, merge the remote-tracking |
118 | branches that the current branch is configured to use as its upstream. | |
93e535a5 | 119 | See also the configuration section of this manual page. |
74e8bc59 JH |
120 | + |
121 | When `FETCH_HEAD` (and no other commit) is specified, the branches | |
122 | recorded in the `.git/FETCH_HEAD` file by the previous invocation | |
123 | of `git fetch` for merging are merged to the current branch. | |
0f69be53 | 124 | |
bb73d73c | 125 | |
30f2bade JN |
126 | PRE-MERGE CHECKS |
127 | ---------------- | |
0f69be53 | 128 | |
30f2bade JN |
129 | Before applying outside changes, you should get your own work in |
130 | good shape and committed locally, so it will not be clobbered if | |
131 | there are conflicts. See also linkgit:git-stash[1]. | |
132 | 'git pull' and 'git merge' will stop without doing anything when | |
133 | local uncommitted changes overlap with files that 'git pull'/'git | |
134 | merge' may need to update. | |
3ae854c3 | 135 | |
30f2bade JN |
136 | To avoid recording unrelated changes in the merge commit, |
137 | 'git pull' and 'git merge' will also abort if there are any changes | |
55f39cf7 EN |
138 | registered in the index relative to the `HEAD` commit. (Special |
139 | narrow exceptions to this rule may exist depending on which merge | |
140 | strategy is in use, but generally, the index must match HEAD.) | |
dbddb714 | 141 | |
30f2bade | 142 | If all named commits are already ancestors of `HEAD`, 'git merge' |
7560f547 | 143 | will exit early with the message "Already up to date." |
3ae854c3 | 144 | |
29280311 JN |
145 | FAST-FORWARD MERGE |
146 | ------------------ | |
147 | ||
148 | Often the current branch head is an ancestor of the named commit. | |
149 | This is the most common case especially when invoked from 'git | |
150 | pull': you are tracking an upstream repository, you have committed | |
151 | no local changes, and now you want to update to a newer upstream | |
152 | revision. In this case, a new commit is not needed to store the | |
153 | combined history; instead, the `HEAD` (along with the index) is | |
154 | updated to point at the named commit, without creating an extra | |
155 | merge commit. | |
156 | ||
157 | This behavior can be suppressed with the `--no-ff` option. | |
ffb1a4be | 158 | |
ebef7e50 JN |
159 | TRUE MERGE |
160 | ---------- | |
c0be8aa0 | 161 | |
29280311 JN |
162 | Except in a fast-forward merge (see above), the branches to be |
163 | merged must be tied together by a merge commit that has both of them | |
164 | as its parents. | |
ffb1a4be | 165 | |
ebef7e50 JN |
166 | A merged version reconciling the changes from all branches to be |
167 | merged is committed, and your `HEAD`, index, and working tree are | |
168 | updated to it. It is possible to have modifications in the working | |
169 | tree as long as they do not overlap; the update will preserve them. | |
ffb1a4be | 170 | |
ebef7e50 JN |
171 | When it is not obvious how to reconcile the changes, the following |
172 | happens: | |
ffb1a4be | 173 | |
ebef7e50 JN |
174 | 1. The `HEAD` pointer stays the same. |
175 | 2. The `MERGE_HEAD` ref is set to point to the other branch head. | |
176 | 3. Paths that merged cleanly are updated both in the index file and | |
ffb1a4be | 177 | in your working tree. |
ebef7e50 JN |
178 | 4. For conflicting paths, the index file records up to three |
179 | versions: stage 1 stores the version from the common ancestor, | |
180 | stage 2 from `HEAD`, and stage 3 from `MERGE_HEAD` (you | |
b1889c36 | 181 | can inspect the stages with `git ls-files -u`). The working |
29b802aa | 182 | tree files contain the result of the "merge" program; i.e. 3-way |
ebef7e50 JN |
183 | merge results with familiar conflict markers `<<<` `===` `>>>`. |
184 | 5. No other changes are made. In particular, the local | |
ffb1a4be JH |
185 | modifications you had before you started merge will stay the |
186 | same and the index entries for them stay as they were, | |
187 | i.e. matching `HEAD`. | |
188 | ||
ed4a6baa | 189 | If you tried a merge which resulted in complex conflicts and |
35d2fffd | 190 | want to start over, you can recover with `git merge --abort`. |
ed4a6baa | 191 | |
77c72780 JH |
192 | MERGING TAG |
193 | ----------- | |
194 | ||
195 | When merging an annotated (and possibly signed) tag, Git always | |
196 | creates a merge commit even if a fast-forward merge is possible, and | |
197 | the commit message template is prepared with the tag message. | |
198 | Additionally, if the tag is signed, the signature check is reported | |
199 | as a comment in the message template. See also linkgit:git-tag[1]. | |
200 | ||
201 | When you want to just integrate with the work leading to the commit | |
202 | that happens to be tagged, e.g. synchronizing with an upstream | |
203 | release point, you may not want to make an unnecessary merge commit. | |
204 | ||
205 | In such a case, you can "unwrap" the tag yourself before feeding it | |
206 | to `git merge`, or pass `--ff-only` when you do not have any work on | |
207 | your own. e.g. | |
208 | ||
e45bda87 | 209 | ---- |
77c72780 JH |
210 | git fetch origin |
211 | git merge v1.2.3^0 | |
212 | git merge --ff-only v1.2.3 | |
e45bda87 | 213 | ---- |
77c72780 JH |
214 | |
215 | ||
70a3f897 JH |
216 | HOW CONFLICTS ARE PRESENTED |
217 | --------------------------- | |
218 | ||
219 | During a merge, the working tree files are updated to reflect the result | |
220 | of the merge. Among the changes made to the common ancestor's version, | |
221 | non-overlapping ones (that is, you changed an area of the file while the | |
222 | other side left that area intact, or vice versa) are incorporated in the | |
223 | final result verbatim. When both sides made changes to the same area, | |
2de9b711 | 224 | however, Git cannot randomly pick one side over the other, and asks you to |
70a3f897 JH |
225 | resolve it by leaving what both sides did to that area. |
226 | ||
2de9b711 | 227 | By default, Git uses the same style as the one used by the "merge" program |
70a3f897 JH |
228 | from the RCS suite to present such a conflicted hunk, like this: |
229 | ||
230 | ------------ | |
231 | Here are lines that are either unchanged from the common | |
232 | ancestor, or cleanly resolved because only one side changed. | |
233 | <<<<<<< yours:sample.txt | |
234 | Conflict resolution is hard; | |
235 | let's go shopping. | |
236 | ======= | |
237 | Git makes conflict resolution easy. | |
238 | >>>>>>> theirs:sample.txt | |
239 | And here is another line that is cleanly resolved or unmodified. | |
240 | ------------ | |
241 | ||
29b802aa | 242 | The area where a pair of conflicting changes happened is marked with markers |
dcb11263 | 243 | `<<<<<<<`, `=======`, and `>>>>>>>`. The part before the `=======` |
29b802aa | 244 | is typically your side, and the part afterwards is typically their side. |
70a3f897 | 245 | |
29b802aa RW |
246 | The default format does not show what the original said in the conflicting |
247 | area. You cannot tell how many lines are deleted and replaced with | |
248 | Barbie's remark on your side. The only thing you can tell is that your | |
70a3f897 JH |
249 | side wants to say it is hard and you'd prefer to go shopping, while the |
250 | other side wants to claim it is easy. | |
251 | ||
da0005b8 | 252 | An alternative style can be used by setting the "merge.conflictStyle" |
70a3f897 JH |
253 | configuration variable to "diff3". In "diff3" style, the above conflict |
254 | may look like this: | |
255 | ||
256 | ------------ | |
257 | Here are lines that are either unchanged from the common | |
258 | ancestor, or cleanly resolved because only one side changed. | |
259 | <<<<<<< yours:sample.txt | |
260 | Conflict resolution is hard; | |
261 | let's go shopping. | |
262 | ||||||| | |
263 | Conflict resolution is hard. | |
264 | ======= | |
265 | Git makes conflict resolution easy. | |
266 | >>>>>>> theirs:sample.txt | |
267 | And here is another line that is cleanly resolved or unmodified. | |
268 | ------------ | |
269 | ||
dcb11263 CJ |
270 | In addition to the `<<<<<<<`, `=======`, and `>>>>>>>` markers, it uses |
271 | another `|||||||` marker that is followed by the original text. You can | |
70a3f897 JH |
272 | tell that the original just stated a fact, and your side simply gave in to |
273 | that statement and gave up, while the other side tried to have a more | |
274 | positive attitude. You can sometimes come up with a better resolution by | |
275 | viewing the original. | |
276 | ||
277 | ||
278 | HOW TO RESOLVE CONFLICTS | |
279 | ------------------------ | |
280 | ||
ffb1a4be JH |
281 | After seeing a conflict, you can do two things: |
282 | ||
29b802aa | 283 | * Decide not to merge. The only clean-ups you need are to reset |
ffb1a4be | 284 | the index file to the `HEAD` commit to reverse 2. and to clean |
35d2fffd JH |
285 | up working tree changes made by 2. and 3.; `git merge --abort` |
286 | can be used for this. | |
ffb1a4be | 287 | |
34ad1afa DH |
288 | * Resolve the conflicts. Git will mark the conflicts in |
289 | the working tree. Edit the files into shape and | |
e2de82f2 MG |
290 | 'git add' them to the index. Use 'git commit' or |
291 | 'git merge --continue' to seal the deal. The latter command | |
292 | checks whether there is a (interrupted) merge in progress | |
293 | before calling 'git commit'. | |
ffb1a4be | 294 | |
34ad1afa DH |
295 | You can work through the conflict with a number of tools: |
296 | ||
ca768288 | 297 | * Use a mergetool. `git mergetool` to launch a graphical |
34ad1afa DH |
298 | mergetool which will work you through the merge. |
299 | ||
ca768288 | 300 | * Look at the diffs. `git diff` will show a three-way diff, |
3588cf94 JN |
301 | highlighting changes from both the `HEAD` and `MERGE_HEAD` |
302 | versions. | |
34ad1afa | 303 | |
3588cf94 JN |
304 | * Look at the diffs from each branch. `git log --merge -p <path>` |
305 | will show diffs first for the `HEAD` version and then the | |
306 | `MERGE_HEAD` version. | |
34ad1afa | 307 | |
ca768288 | 308 | * Look at the originals. `git show :1:filename` shows the |
3588cf94 JN |
309 | common ancestor, `git show :2:filename` shows the `HEAD` |
310 | version, and `git show :3:filename` shows the `MERGE_HEAD` | |
311 | version. | |
ffb1a4be | 312 | |
d504f697 CB |
313 | |
314 | EXAMPLES | |
315 | -------- | |
316 | ||
317 | * Merge branches `fixes` and `enhancements` on top of | |
318 | the current branch, making an octopus merge: | |
319 | + | |
320 | ------------------------------------------------ | |
321 | $ git merge fixes enhancements | |
322 | ------------------------------------------------ | |
323 | ||
324 | * Merge branch `obsolete` into the current branch, using `ours` | |
325 | merge strategy: | |
326 | + | |
327 | ------------------------------------------------ | |
328 | $ git merge -s ours obsolete | |
329 | ------------------------------------------------ | |
330 | ||
331 | * Merge branch `maint` into the current branch, but do not make | |
332 | a new commit automatically: | |
333 | + | |
334 | ------------------------------------------------ | |
335 | $ git merge --no-commit maint | |
336 | ------------------------------------------------ | |
337 | + | |
338 | This can be used when you want to include further changes to the | |
339 | merge, or want to write your own merge commit message. | |
340 | + | |
341 | You should refrain from abusing this option to sneak substantial | |
342 | changes into a merge commit. Small fixups like bumping | |
343 | release/version name would be acceptable. | |
344 | ||
345 | ||
a4081bac JN |
346 | include::merge-strategies.txt[] |
347 | ||
35e9d630 JN |
348 | CONFIGURATION |
349 | ------------- | |
7fb5ab4a | 350 | include::config/merge.txt[] |
35e9d630 | 351 | |
da0005b8 | 352 | branch.<name>.mergeOptions:: |
35e9d630 JN |
353 | Sets default options for merging into branch <name>. The syntax and |
354 | supported options are the same as those of 'git merge', but option | |
355 | values containing whitespace characters are currently not supported. | |
356 | ||
3c64314c PB |
357 | SEE ALSO |
358 | -------- | |
5162e697 | 359 | linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1], |
483bc4f0 JN |
360 | linkgit:gitattributes[5], |
361 | linkgit:git-reset[1], | |
362 | linkgit:git-diff[1], linkgit:git-ls-files[1], | |
363 | linkgit:git-add[1], linkgit:git-rm[1], | |
364 | linkgit:git-mergetool[1] | |
3c64314c | 365 | |
0f69be53 JH |
366 | GIT |
367 | --- | |
9e1f0a85 | 368 | Part of the linkgit:git[1] suite |