Autogenerated manpages for v2.40.0-rc2
[git-manpages.git] / man1 / git-merge.1
blob8efc19100d4e0bea9c4becad8e3f98c6a0c0edf7
1 '\" t
2 .\"     Title: git-merge
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: 03/06/2023
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.40.0.rc2
8 .\"  Language: English
9 .\"
10 .TH "GIT\-MERGE" "1" "03/06/2023" "Git 2\&.40\&.0\&.rc2" "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-merge \- Join two or more development histories together
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit merge\fR [\-n] [\-\-stat] [\-\-no\-commit] [\-\-squash] [\-\-[no\-]edit]
36         [\-\-no\-verify] [\-s <strategy>] [\-X <strategy\-option>] [\-S[<keyid>]]
37         [\-\-[no\-]allow\-unrelated\-histories]
38         [\-\-[no\-]rerere\-autoupdate] [\-m <msg>] [\-F <file>]
39         [\-\-into\-name <branch>] [<commit>\&...]
40 \fIgit merge\fR (\-\-continue | \-\-abort | \-\-quit)
41 .fi
42 .sp
43 .SH "DESCRIPTION"
44 .sp
45 Incorporates changes from the named commits (since the time their histories diverged from the current branch) into the current branch\&. This command is used by \fIgit pull\fR to incorporate changes from another repository and can be used by hand to merge changes from one branch into another\&.
46 .sp
47 Assume the following history exists and the current branch is "\fBmaster\fR":
48 .sp
49 .if n \{\
50 .RS 4
51 .\}
52 .nf
53           A\-\-\-B\-\-\-C topic
54          /
55     D\-\-\-E\-\-\-F\-\-\-G master
56 .fi
57 .if n \{\
58 .RE
59 .\}
60 .sp
61 .sp
62 Then "\fBgit merge topic\fR" will replay the changes made on the \fBtopic\fR branch since it diverged from \fBmaster\fR (i\&.e\&., \fBE\fR) until its current commit (\fBC\fR) on top of \fBmaster\fR, and record the result in a new commit along with the names of the two parent commits and a log message from the user describing the changes\&. Before the operation, \fBORIG_HEAD\fR is set to the tip of the current branch (\fBC\fR)\&.
63 .sp
64 .if n \{\
65 .RS 4
66 .\}
67 .nf
68           A\-\-\-B\-\-\-C topic
69          /         \e
70     D\-\-\-E\-\-\-F\-\-\-G\-\-\-H master
71 .fi
72 .if n \{\
73 .RE
74 .\}
75 .sp
76 .sp
77 The second syntax ("\fBgit merge \-\-abort\fR") can only be run after the merge has resulted in conflicts\&. \fIgit merge \-\-abort\fR will abort the merge process and try to reconstruct the pre\-merge state\&. However, if there were uncommitted changes when the merge started (and especially if those changes were further modified after the merge was started), \fIgit merge \-\-abort\fR will in some cases be unable to reconstruct the original (pre\-merge) changes\&. Therefore:
78 .sp
79 \fBWarning\fR: Running \fIgit merge\fR with non\-trivial uncommitted changes is discouraged: while possible, it may leave you in a state that is hard to back out of in the case of a conflict\&.
80 .sp
81 The third syntax ("\fBgit merge \-\-continue\fR") can only be run after the merge has resulted in conflicts\&.
82 .SH "OPTIONS"
83 .PP
84 \-\-commit, \-\-no\-commit
85 .RS 4
86 Perform the merge and commit the result\&. This option can be used to override \-\-no\-commit\&.
87 .sp
88 With \-\-no\-commit perform the merge and stop just before creating a merge commit, to give the user a chance to inspect and further tweak the merge result before committing\&.
89 .sp
90 Note that fast\-forward updates do not create a merge commit and therefore there is no way to stop those merges with \-\-no\-commit\&. Thus, if you want to ensure your branch is not changed or updated by the merge command, use \-\-no\-ff with \-\-no\-commit\&.
91 .RE
92 .PP
93 \-\-edit, \-e, \-\-no\-edit
94 .RS 4
95 Invoke an editor before committing successful mechanical merge to further edit the auto\-generated merge message, so that the user can explain and justify the merge\&. The
96 \fB\-\-no\-edit\fR
97 option can be used to accept the auto\-generated message (this is generally discouraged)\&. The
98 \fB\-\-edit\fR
99 (or
100 \fB\-e\fR) option is still useful if you are giving a draft message with the
101 \fB\-m\fR
102 option from the command line and want to edit it in the editor\&.
104 Older scripts may depend on the historical behaviour of not allowing the user to edit the merge log message\&. They will see an editor opened when they run
105 \fBgit merge\fR\&. To make it easier to adjust such scripts to the updated behaviour, the environment variable
106 \fBGIT_MERGE_AUTOEDIT\fR
107 can be set to
108 \fBno\fR
109 at the beginning of them\&.
112 \-\-cleanup=<mode>
113 .RS 4
114 This option determines how the merge message will be cleaned up before committing\&. See
115 \fBgit-commit\fR(1)
116 for more details\&. In addition, if the
117 \fI<mode>\fR
118 is given a value of
119 \fBscissors\fR, scissors will be appended to
120 \fBMERGE_MSG\fR
121 before being passed on to the commit machinery in the case of a merge conflict\&.
124 \-\-ff, \-\-no\-ff, \-\-ff\-only
125 .RS 4
126 Specifies how a merge is handled when the merged\-in history is already a descendant of the current history\&.
127 \fB\-\-ff\fR
128 is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the
129 \fBrefs/tags/\fR
130 hierarchy, in which case
131 \fB\-\-no\-ff\fR
132 is assumed\&.
134 With
135 \fB\-\-ff\fR, when possible resolve the merge as a fast\-forward (only update the branch pointer to match the merged branch; do not create a merge commit)\&. When not possible (when the merged\-in history is not a descendant of the current history), create a merge commit\&.
137 With
138 \fB\-\-no\-ff\fR, create a merge commit in all cases, even when the merge could instead be resolved as a fast\-forward\&.
140 With
141 \fB\-\-ff\-only\fR, resolve the merge as a fast\-forward when possible\&. When not possible, refuse to merge and exit with a non\-zero status\&.
144 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
145 .RS 4
146 GPG\-sign the resulting merge commit\&. The
147 \fBkeyid\fR
148 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
149 \fB\-\-no\-gpg\-sign\fR
150 is useful to countermand both
151 \fBcommit\&.gpgSign\fR
152 configuration variable, and earlier
153 \fB\-\-gpg\-sign\fR\&.
156 \-\-log[=<n>], \-\-no\-log
157 .RS 4
158 In addition to branch names, populate the log message with one\-line descriptions from at most <n> actual commits that are being merged\&. See also
159 \fBgit-fmt-merge-msg\fR(1)\&.
161 With \-\-no\-log do not list one\-line descriptions from the actual commits being merged\&.
164 \-\-signoff, \-\-no\-signoff
165 .RS 4
166 Add a
167 \fBSigned\-off\-by\fR
168 trailer by the committer at the end of the commit log message\&. The meaning of a signoff depends on the project to which you\(cqre committing\&. For example, it may certify that the committer has the rights to submit the work under the project\(cqs license or agrees to some contributor representation, such as a Developer Certificate of Origin\&. (See
169 \m[blue]\fBhttp://developercertificate\&.org\fR\m[]
170 for the one used by the Linux kernel and Git projects\&.) Consult the documentation or leadership of the project to which you\(cqre contributing to understand how the signoffs are used in that project\&.
172 The \-\-no\-signoff option can be used to countermand an earlier \-\-signoff option on the command line\&.
175 \-\-stat, \-n, \-\-no\-stat
176 .RS 4
177 Show a diffstat at the end of the merge\&. The diffstat is also controlled by the configuration option merge\&.stat\&.
179 With \-n or \-\-no\-stat do not show a diffstat at the end of the merge\&.
182 \-\-squash, \-\-no\-squash
183 .RS 4
184 Produce the working tree and index state as if a real merge happened (except for the merge information), but do not actually make a commit, move the
185 \fBHEAD\fR, or record
186 \fB$GIT_DIR/MERGE_HEAD\fR
187 (to cause the next
188 \fBgit commit\fR
189 command to create a merge commit)\&. This allows you to create a single commit on top of the current branch whose effect is the same as merging another branch (or more in case of an octopus)\&.
191 With \-\-no\-squash perform the merge and commit the result\&. This option can be used to override \-\-squash\&.
193 With \-\-squash, \-\-commit is not allowed, and will fail\&.
196 \-\-[no\-]verify
197 .RS 4
198 By default, the pre\-merge and commit\-msg hooks are run\&. When
199 \fB\-\-no\-verify\fR
200 is given, these are bypassed\&. See also
201 \fBgithooks\fR(5)\&.
204 \-s <strategy>, \-\-strategy=<strategy>
205 .RS 4
206 Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried\&. If there is no
207 \fB\-s\fR
208 option, a built\-in list of strategies is used instead (\fBort\fR
209 when merging a single head,
210 \fBoctopus\fR
211 otherwise)\&.
214 \-X <option>, \-\-strategy\-option=<option>
215 .RS 4
216 Pass merge strategy specific option through to the merge strategy\&.
219 \-\-verify\-signatures, \-\-no\-verify\-signatures
220 .RS 4
221 Verify that the tip commit of the side branch being merged is signed with a valid key, i\&.e\&. a key that has a valid uid: in the default trust model, this means the signing key has been signed by a trusted key\&. If the tip commit of the side branch is not signed with a valid key, the merge is aborted\&.
224 \-\-summary, \-\-no\-summary
225 .RS 4
226 Synonyms to \-\-stat and \-\-no\-stat; these are deprecated and will be removed in the future\&.
229 \-q, \-\-quiet
230 .RS 4
231 Operate quietly\&. Implies \-\-no\-progress\&.
234 \-v, \-\-verbose
235 .RS 4
236 Be verbose\&.
239 \-\-progress, \-\-no\-progress
240 .RS 4
241 Turn progress on/off explicitly\&. If neither is specified, progress is shown if standard error is connected to a terminal\&. Note that not all merge strategies may support progress reporting\&.
244 \-\-autostash, \-\-no\-autostash
245 .RS 4
246 Automatically create a temporary stash entry before the operation begins, record it in the special ref
247 \fBMERGE_AUTOSTASH\fR
248 and apply it after the operation ends\&. This means that you can run the operation on a dirty worktree\&. However, use with care: the final stash application after a successful merge might result in non\-trivial conflicts\&.
251 \-\-allow\-unrelated\-histories
252 .RS 4
253 By default,
254 \fBgit merge\fR
255 command refuses to merge histories that do not share a common ancestor\&. This option can be used to override this safety when merging histories of two projects that started their lives independently\&. As that is a very rare occasion, no configuration variable to enable this by default exists and will not be added\&.
258 \-m <msg>
259 .RS 4
260 Set the commit message to be used for the merge commit (in case one is created)\&.
263 \fB\-\-log\fR
264 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
267 \fIgit fmt\-merge\-msg\fR
268 command can be used to give a good default for automated
269 \fIgit merge\fR
270 invocations\&. The automated message can include the branch description\&.
273 \-\-into\-name <branch>
274 .RS 4
275 Prepare the default merge message as if merging to the branch
276 \fB<branch>\fR, instead of the name of the real branch to which the merge is made\&.
279 \-F <file>, \-\-file=<file>
280 .RS 4
281 Read the commit message to be used for the merge commit (in case one is created)\&.
284 \fB\-\-log\fR
285 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
288 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
289 .RS 4
290 After the rerere mechanism reuses a recorded resolution on the current conflict to update the files in the working tree, allow it to also update the index with the result of resolution\&.
291 \fB\-\-no\-rerere\-autoupdate\fR
292 is a good way to double\-check what
293 \fBrerere\fR
294 did and catch potential mismerges, before committing the result to the index with a separate
295 \fBgit add\fR\&.
298 \-\-overwrite\-ignore, \-\-no\-overwrite\-ignore
299 .RS 4
300 Silently overwrite ignored files from the merge result\&. This is the default behavior\&. Use
301 \fB\-\-no\-overwrite\-ignore\fR
302 to abort\&.
305 \-\-abort
306 .RS 4
307 Abort the current conflict resolution process, and try to reconstruct the pre\-merge state\&. If an autostash entry is present, apply it to the worktree\&.
309 If there were uncommitted worktree changes present when the merge started,
310 \fIgit merge \-\-abort\fR
311 will in some cases be unable to reconstruct these changes\&. It is therefore recommended to always commit or stash your changes before running
312 \fIgit merge\fR\&.
314 \fIgit merge \-\-abort\fR
315 is equivalent to
316 \fIgit reset \-\-merge\fR
317 when
318 \fBMERGE_HEAD\fR
319 is present unless
320 \fBMERGE_AUTOSTASH\fR
321 is also present in which case
322 \fIgit merge \-\-abort\fR
323 applies the stash entry to the worktree whereas
324 \fIgit reset \-\-merge\fR
325 will save the stashed changes in the stash list\&.
328 \-\-quit
329 .RS 4
330 Forget about the current merge in progress\&. Leave the index and the working tree as\-is\&. If
331 \fBMERGE_AUTOSTASH\fR
332 is present, the stash entry will be saved to the stash list\&.
335 \-\-continue
336 .RS 4
337 After a
338 \fIgit merge\fR
339 stops due to conflicts you can conclude the merge by running
340 \fIgit merge \-\-continue\fR
341 (see "HOW TO RESOLVE CONFLICTS" section below)\&.
344 <commit>\&...
345 .RS 4
346 Commits, usually other branch heads, to merge into our branch\&. Specifying more than one commit will create a merge with more than two parents (affectionately called an Octopus merge)\&.
348 If no commit is given from the command line, merge the remote\-tracking branches that the current branch is configured to use as its upstream\&. See also the configuration section of this manual page\&.
350 When
351 \fBFETCH_HEAD\fR
352 (and no other commit) is specified, the branches recorded in the
353 \fB\&.git/FETCH_HEAD\fR
354 file by the previous invocation of
355 \fBgit fetch\fR
356 for merging are merged to the current branch\&.
358 .SH "PRE\-MERGE CHECKS"
360 Before applying outside changes, you should get your own work in good shape and committed locally, so it will not be clobbered if there are conflicts\&. See also \fBgit-stash\fR(1)\&. \fIgit pull\fR and \fIgit merge\fR will stop without doing anything when local uncommitted changes overlap with files that \fIgit pull\fR/\fIgit merge\fR may need to update\&.
362 To avoid recording unrelated changes in the merge commit, \fIgit pull\fR and \fIgit merge\fR will also abort if there are any changes registered in the index relative to the \fBHEAD\fR commit\&. (Special narrow exceptions to this rule may exist depending on which merge strategy is in use, but generally, the index must match HEAD\&.)
364 If all named commits are already ancestors of \fBHEAD\fR, \fIgit merge\fR will exit early with the message "Already up to date\&."
365 .SH "FAST\-FORWARD MERGE"
367 Often the current branch head is an ancestor of the named commit\&. This is the most common case especially when invoked from \fIgit pull\fR: you are tracking an upstream repository, you have committed no local changes, and now you want to update to a newer upstream revision\&. In this case, a new commit is not needed to store the combined history; instead, the \fBHEAD\fR (along with the index) is updated to point at the named commit, without creating an extra merge commit\&.
369 This behavior can be suppressed with the \fB\-\-no\-ff\fR option\&.
370 .SH "TRUE MERGE"
372 Except in a fast\-forward merge (see above), the branches to be merged must be tied together by a merge commit that has both of them as its parents\&.
374 A merged version reconciling the changes from all branches to be merged is committed, and your \fBHEAD\fR, index, and working tree are updated to it\&. It is possible to have modifications in the working tree as long as they do not overlap; the update will preserve them\&.
376 When it is not obvious how to reconcile the changes, the following happens:
378 .RS 4
379 .ie n \{\
380 \h'-04' 1.\h'+01'\c
382 .el \{\
383 .sp -1
384 .IP "  1." 4.2
387 \fBHEAD\fR
388 pointer stays the same\&.
391 .RS 4
392 .ie n \{\
393 \h'-04' 2.\h'+01'\c
395 .el \{\
396 .sp -1
397 .IP "  2." 4.2
400 \fBMERGE_HEAD\fR
401 ref is set to point to the other branch head\&.
404 .RS 4
405 .ie n \{\
406 \h'-04' 3.\h'+01'\c
408 .el \{\
409 .sp -1
410 .IP "  3." 4.2
412 Paths that merged cleanly are updated both in the index file and in your working tree\&.
415 .RS 4
416 .ie n \{\
417 \h'-04' 4.\h'+01'\c
419 .el \{\
420 .sp -1
421 .IP "  4." 4.2
423 For conflicting paths, the index file records up to three versions: stage 1 stores the version from the common ancestor, stage 2 from
424 \fBHEAD\fR, and stage 3 from
425 \fBMERGE_HEAD\fR
426 (you can inspect the stages with
427 \fBgit ls\-files \-u\fR)\&. The working tree files contain the result of the "merge" program; i\&.e\&. 3\-way merge results with familiar conflict markers
428 \fB<<<\fR
429 \fB===\fR
430 \fB>>>\fR\&.
433 .RS 4
434 .ie n \{\
435 \h'-04' 5.\h'+01'\c
437 .el \{\
438 .sp -1
439 .IP "  5." 4.2
441 No other changes are made\&. In particular, the local modifications you had before you started merge will stay the same and the index entries for them stay as they were, i\&.e\&. matching
442 \fBHEAD\fR\&.
445 If you tried a merge which resulted in complex conflicts and want to start over, you can recover with \fBgit merge \-\-abort\fR\&.
446 .SH "MERGING TAG"
448 When merging an annotated (and possibly signed) tag, Git always creates a merge commit even if a fast\-forward merge is possible, and the commit message template is prepared with the tag message\&. Additionally, if the tag is signed, the signature check is reported as a comment in the message template\&. See also \fBgit-tag\fR(1)\&.
450 When you want to just integrate with the work leading to the commit that happens to be tagged, e\&.g\&. synchronizing with an upstream release point, you may not want to make an unnecessary merge commit\&.
452 In such a case, you can "unwrap" the tag yourself before feeding it to \fBgit merge\fR, or pass \fB\-\-ff\-only\fR when you do not have any work on your own\&. e\&.g\&.
454 .if n \{\
455 .RS 4
458 git fetch origin
459 git merge v1\&.2\&.3^0
460 git merge \-\-ff\-only v1\&.2\&.3
462 .if n \{\
466 .SH "HOW CONFLICTS ARE PRESENTED"
468 During a merge, the working tree files are updated to reflect the result of the merge\&. Among the changes made to the common ancestor\(cqs version, non\-overlapping ones (that is, you changed an area of the file while the other side left that area intact, or vice versa) are incorporated in the final result verbatim\&. When both sides made changes to the same area, however, Git cannot randomly pick one side over the other, and asks you to resolve it by leaving what both sides did to that area\&.
470 By default, Git uses the same style as the one used by the "merge" program from the RCS suite to present such a conflicted hunk, like this:
472 .if n \{\
473 .RS 4
476 Here are lines that are either unchanged from the common
477 ancestor, or cleanly resolved because only one side changed,
478 or cleanly resolved because both sides changed the same way\&.
479 <<<<<<< yours:sample\&.txt
480 Conflict resolution is hard;
481 let\(aqs go shopping\&.
482 =======
483 Git makes conflict resolution easy\&.
484 >>>>>>> theirs:sample\&.txt
485 And here is another line that is cleanly resolved or unmodified\&.
487 .if n \{\
492 The area where a pair of conflicting changes happened is marked with markers \fB<<<<<<<\fR, \fB=======\fR, and \fB>>>>>>>\fR\&. The part before the \fB=======\fR is typically your side, and the part afterwards is typically their side\&.
494 The default format does not show what the original said in the conflicting area\&. You cannot tell how many lines are deleted and replaced with Barbie\(cqs remark on your side\&. The only thing you can tell is that your side wants to say it is hard and you\(cqd prefer to go shopping, while the other side wants to claim it is easy\&.
496 An alternative style can be used by setting the "merge\&.conflictStyle" configuration variable to either "diff3" or "zdiff3"\&. In "diff3" style, the above conflict may look like this:
498 .if n \{\
499 .RS 4
502 Here are lines that are either unchanged from the common
503 ancestor, or cleanly resolved because only one side changed,
504 <<<<<<< yours:sample\&.txt
505 or cleanly resolved because both sides changed the same way\&.
506 Conflict resolution is hard;
507 let\(aqs go shopping\&.
508 ||||||| base:sample\&.txt
509 or cleanly resolved because both sides changed identically\&.
510 Conflict resolution is hard\&.
511 =======
512 or cleanly resolved because both sides changed the same way\&.
513 Git makes conflict resolution easy\&.
514 >>>>>>> theirs:sample\&.txt
515 And here is another line that is cleanly resolved or unmodified\&.
517 .if n \{\
522 while in "zdiff3" style, it may look like this:
524 .if n \{\
525 .RS 4
528 Here are lines that are either unchanged from the common
529 ancestor, or cleanly resolved because only one side changed,
530 or cleanly resolved because both sides changed the same way\&.
531 <<<<<<< yours:sample\&.txt
532 Conflict resolution is hard;
533 let\(aqs go shopping\&.
534 ||||||| base:sample\&.txt
535 or cleanly resolved because both sides changed identically\&.
536 Conflict resolution is hard\&.
537 =======
538 Git makes conflict resolution easy\&.
539 >>>>>>> theirs:sample\&.txt
540 And here is another line that is cleanly resolved or unmodified\&.
542 .if n \{\
547 In addition to the \fB<<<<<<<\fR, \fB=======\fR, and \fB>>>>>>>\fR markers, it uses another \fB|||||||\fR marker that is followed by the original text\&. You can tell that the original just stated a fact, and your side simply gave in to that statement and gave up, while the other side tried to have a more positive attitude\&. You can sometimes come up with a better resolution by viewing the original\&.
548 .SH "HOW TO RESOLVE CONFLICTS"
550 After seeing a conflict, you can do two things:
552 .RS 4
553 .ie n \{\
554 \h'-04'\(bu\h'+03'\c
556 .el \{\
557 .sp -1
558 .IP \(bu 2.3
560 Decide not to merge\&. The only clean\-ups you need are to reset the index file to the
561 \fBHEAD\fR
562 commit to reverse 2\&. and to clean up working tree changes made by 2\&. and 3\&.;
563 \fBgit merge \-\-abort\fR
564 can be used for this\&.
567 .RS 4
568 .ie n \{\
569 \h'-04'\(bu\h'+03'\c
571 .el \{\
572 .sp -1
573 .IP \(bu 2.3
575 Resolve the conflicts\&. Git will mark the conflicts in the working tree\&. Edit the files into shape and
576 \fIgit add\fR
577 them to the index\&. Use
578 \fIgit commit\fR
580 \fIgit merge \-\-continue\fR
581 to seal the deal\&. The latter command checks whether there is a (interrupted) merge in progress before calling
582 \fIgit commit\fR\&.
585 You can work through the conflict with a number of tools:
587 .RS 4
588 .ie n \{\
589 \h'-04'\(bu\h'+03'\c
591 .el \{\
592 .sp -1
593 .IP \(bu 2.3
595 Use a mergetool\&.
596 \fBgit mergetool\fR
597 to launch a graphical mergetool which will work you through the merge\&.
600 .RS 4
601 .ie n \{\
602 \h'-04'\(bu\h'+03'\c
604 .el \{\
605 .sp -1
606 .IP \(bu 2.3
608 Look at the diffs\&.
609 \fBgit diff\fR
610 will show a three\-way diff, highlighting changes from both the
611 \fBHEAD\fR
613 \fBMERGE_HEAD\fR
614 versions\&.
617 .RS 4
618 .ie n \{\
619 \h'-04'\(bu\h'+03'\c
621 .el \{\
622 .sp -1
623 .IP \(bu 2.3
625 Look at the diffs from each branch\&.
626 \fBgit log \-\-merge \-p <path>\fR
627 will show diffs first for the
628 \fBHEAD\fR
629 version and then the
630 \fBMERGE_HEAD\fR
631 version\&.
634 .RS 4
635 .ie n \{\
636 \h'-04'\(bu\h'+03'\c
638 .el \{\
639 .sp -1
640 .IP \(bu 2.3
642 Look at the originals\&.
643 \fBgit show :1:filename\fR
644 shows the common ancestor,
645 \fBgit show :2:filename\fR
646 shows the
647 \fBHEAD\fR
648 version, and
649 \fBgit show :3:filename\fR
650 shows the
651 \fBMERGE_HEAD\fR
652 version\&.
654 .SH "EXAMPLES"
656 .RS 4
657 .ie n \{\
658 \h'-04'\(bu\h'+03'\c
660 .el \{\
661 .sp -1
662 .IP \(bu 2.3
664 Merge branches
665 \fBfixes\fR
667 \fBenhancements\fR
668 on top of the current branch, making an octopus merge:
670 .if n \{\
671 .RS 4
674 $ git merge fixes enhancements
676 .if n \{\
682 .RS 4
683 .ie n \{\
684 \h'-04'\(bu\h'+03'\c
686 .el \{\
687 .sp -1
688 .IP \(bu 2.3
690 Merge branch
691 \fBobsolete\fR
692 into the current branch, using
693 \fBours\fR
694 merge strategy:
696 .if n \{\
697 .RS 4
700 $ git merge \-s ours obsolete
702 .if n \{\
708 .RS 4
709 .ie n \{\
710 \h'-04'\(bu\h'+03'\c
712 .el \{\
713 .sp -1
714 .IP \(bu 2.3
716 Merge branch
717 \fBmaint\fR
718 into the current branch, but do not make a new commit automatically:
720 .if n \{\
721 .RS 4
724 $ git merge \-\-no\-commit maint
726 .if n \{\
730 This can be used when you want to include further changes to the merge, or want to write your own merge commit message\&.
732 You should refrain from abusing this option to sneak substantial changes into a merge commit\&. Small fixups like bumping release/version name would be acceptable\&.
734 .SH "MERGE STRATEGIES"
736 The merge mechanism (\fBgit merge\fR and \fBgit pull\fR commands) allows the backend \fImerge strategies\fR to be chosen with \fB\-s\fR option\&. Some strategies can also take their own options, which can be passed by giving \fB\-X<option>\fR arguments to \fBgit merge\fR and/or \fBgit pull\fR\&.
739 .RS 4
740 This is the default merge strategy when pulling or merging one branch\&. This strategy can only resolve two heads using a 3\-way merge algorithm\&. When there is more than one common ancestor that can be used for 3\-way merge, it creates a merged tree of the common ancestors and uses that as the reference tree for the 3\-way merge\&. This has been reported to result in fewer merge conflicts without causing mismerges by tests done on actual merge commits taken from Linux 2\&.6 kernel development history\&. Additionally this strategy can detect and handle merges involving renames\&. It does not make use of detected copies\&. The name for this algorithm is an acronym ("Ostensibly Recursive\(cqs Twin") and came from the fact that it was written as a replacement for the previous default algorithm,
741 \fBrecursive\fR\&.
744 \fIort\fR
745 strategy can take the following options:
747 ours
748 .RS 4
749 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
750 \fIour\fR
751 version\&. Changes from the other tree that do not conflict with our side are reflected in the merge result\&. For a binary file, the entire contents are taken from our side\&.
753 This should not be confused with the
754 \fIours\fR
755 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
756 \fIour\fR
757 history contains all that happened in it\&.
760 theirs
761 .RS 4
762 This is the opposite of
763 \fIours\fR; note that, unlike
764 \fIours\fR, there is no
765 \fItheirs\fR
766 merge strategy to confuse this merge option with\&.
769 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
770 .RS 4
771 Treats lines with the indicated type of whitespace change as unchanged for the sake of a three\-way merge\&. Whitespace changes mixed with other changes to a line are not ignored\&. See also
772 \fBgit-diff\fR(1)
773 \fB\-b\fR,
774 \fB\-w\fR,
775 \fB\-\-ignore\-space\-at\-eol\fR, and
776 \fB\-\-ignore\-cr\-at\-eol\fR\&.
778 .RS 4
779 .ie n \{\
780 \h'-04'\(bu\h'+03'\c
782 .el \{\
783 .sp -1
784 .IP \(bu 2.3
787 \fItheir\fR
788 version only introduces whitespace changes to a line,
789 \fIour\fR
790 version is used;
793 .RS 4
794 .ie n \{\
795 \h'-04'\(bu\h'+03'\c
797 .el \{\
798 .sp -1
799 .IP \(bu 2.3
802 \fIour\fR
803 version introduces whitespace changes but
804 \fItheir\fR
805 version includes a substantial change,
806 \fItheir\fR
807 version is used;
810 .RS 4
811 .ie n \{\
812 \h'-04'\(bu\h'+03'\c
814 .el \{\
815 .sp -1
816 .IP \(bu 2.3
818 Otherwise, the merge proceeds in the usual way\&.
822 renormalize
823 .RS 4
824 This runs a virtual check\-out and check\-in of all three stages of a file when resolving a three\-way merge\&. This option is meant to be used when merging branches with different clean filters or end\-of\-line normalization rules\&. See "Merging branches with differing checkin/checkout attributes" in
825 \fBgitattributes\fR(5)
826 for details\&.
829 no\-renormalize
830 .RS 4
831 Disables the
832 \fBrenormalize\fR
833 option\&. This overrides the
834 \fBmerge\&.renormalize\fR
835 configuration variable\&.
838 find\-renames[=<n>]
839 .RS 4
840 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
841 \fImerge\&.renames\fR
842 configuration variable\&. See also
843 \fBgit-diff\fR(1)
844 \fB\-\-find\-renames\fR\&.
847 rename\-threshold=<n>
848 .RS 4
849 Deprecated synonym for
850 \fBfind\-renames=<n>\fR\&.
853 subtree[=<path>]
854 .RS 4
855 This option is a more advanced form of
856 \fIsubtree\fR
857 strategy, where the strategy makes a guess on how two trees must be shifted to match with each other when merging\&. Instead, the specified path is prefixed (or stripped from the beginning) to make the shape of two trees to match\&.
861 recursive
862 .RS 4
863 This can only resolve two heads using a 3\-way merge algorithm\&. When there is more than one common ancestor that can be used for 3\-way merge, it creates a merged tree of the common ancestors and uses that as the reference tree for the 3\-way merge\&. This has been reported to result in fewer merge conflicts without causing mismerges by tests done on actual merge commits taken from Linux 2\&.6 kernel development history\&. Additionally this can detect and handle merges involving renames\&. It does not make use of detected copies\&. This was the default strategy for resolving two heads from Git v0\&.99\&.9k until v2\&.33\&.0\&.
866 \fIrecursive\fR
867 strategy takes the same options as
868 \fIort\fR\&. However, there are three additional options that
869 \fIort\fR
870 ignores (not documented above) that are potentially useful with the
871 \fIrecursive\fR
872 strategy:
874 patience
875 .RS 4
876 Deprecated synonym for
877 \fBdiff\-algorithm=patience\fR\&.
880 diff\-algorithm=[patience|minimal|histogram|myers]
881 .RS 4
882 Use a different diff algorithm while merging, which can help avoid mismerges that occur due to unimportant matching lines (such as braces from distinct functions)\&. See also
883 \fBgit-diff\fR(1)
884 \fB\-\-diff\-algorithm\fR\&. Note that
885 \fBort\fR
886 specifically uses
887 \fBdiff\-algorithm=histogram\fR, while
888 \fBrecursive\fR
889 defaults to the
890 \fBdiff\&.algorithm\fR
891 config setting\&.
894 no\-renames
895 .RS 4
896 Turn off rename detection\&. This overrides the
897 \fBmerge\&.renames\fR
898 configuration variable\&. See also
899 \fBgit-diff\fR(1)
900 \fB\-\-no\-renames\fR\&.
904 resolve
905 .RS 4
906 This can only resolve two heads (i\&.e\&. the current branch and another branch you pulled from) using a 3\-way merge algorithm\&. It tries to carefully detect criss\-cross merge ambiguities\&. It does not handle renames\&.
909 octopus
910 .RS 4
911 This resolves cases with more than two heads, but refuses to do a complex merge that needs manual resolution\&. It is primarily meant to be used for bundling topic branch heads together\&. This is the default merge strategy when pulling or merging more than one branch\&.
914 ours
915 .RS 4
916 This resolves any number of heads, but the resulting tree of the merge is always that of the current branch head, effectively ignoring all changes from all other branches\&. It is meant to be used to supersede old development history of side branches\&. Note that this is different from the \-Xours option to the
917 \fIrecursive\fR
918 merge strategy\&.
921 subtree
922 .RS 4
923 This is a modified
924 \fBort\fR
925 strategy\&. When merging trees A and B, if B corresponds to a subtree of A, B is first adjusted to match the tree structure of A, instead of reading the trees at the same level\&. This adjustment is also done to the common ancestor tree\&.
928 With the strategies that use 3\-way merge (including the default, \fIort\fR), if a change is made on both branches, but later reverted on one of the branches, that change will be present in the merged result; some people find this behavior confusing\&. It occurs because only the heads and the merge base are considered when performing a merge, not the individual commits\&. The merge algorithm therefore considers the reverted change as no change at all, and substitutes the changed version instead\&.
929 .SH "CONFIGURATION"
931 branch\&.<name>\&.mergeOptions
932 .RS 4
933 Sets default options for merging into branch <name>\&. The syntax and supported options are the same as those of
934 \fIgit merge\fR, but option values containing whitespace characters are currently not supported\&.
937 Everything above this line in this section isn\(cqt included from the \fBgit-config\fR(1) documentation\&. The content that follows is the same as what\(cqs found there:
939 merge\&.conflictStyle
940 .RS 4
941 Specify the style in which conflicted hunks are written out to working tree files upon merge\&. The default is "merge", which shows a
942 \fB<<<<<<<\fR
943 conflict marker, changes made by one side, a
944 \fB=======\fR
945 marker, changes made by the other side, and then a
946 \fB>>>>>>>\fR
947 marker\&. An alternate style, "diff3", adds a
948 \fB|||||||\fR
949 marker and the original text before the
950 \fB=======\fR
951 marker\&. The "merge" style tends to produce smaller conflict regions than diff3, both because of the exclusion of the original text, and because when a subset of lines match on the two sides they are just pulled out of the conflict region\&. Another alternate style, "zdiff3", is similar to diff3 but removes matching lines on the two sides from the conflict region when those matching lines appear near either the beginning or end of a conflict region\&.
954 merge\&.defaultToUpstream
955 .RS 4
956 If merge is called without any commit argument, merge the upstream branches configured for the current branch by using their last observed values stored in their remote\-tracking branches\&. The values of the
957 \fBbranch\&.<current branch>\&.merge\fR
958 that name the branches at the remote named by
959 \fBbranch\&.<current branch>\&.remote\fR
960 are consulted, and then they are mapped via
961 \fBremote\&.<remote>\&.fetch\fR
962 to their corresponding remote\-tracking branches, and the tips of these tracking branches are merged\&. Defaults to true\&.
965 merge\&.ff
966 .RS 4
967 By default, Git does not create an extra merge commit when merging a commit that is a descendant of the current commit\&. Instead, the tip of the current branch is fast\-forwarded\&. When set to
968 \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
969 \fB\-\-no\-ff\fR
970 option from the command line)\&. When set to
971 \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
972 \fB\-\-ff\-only\fR
973 option from the command line)\&.
976 merge\&.verifySignatures
977 .RS 4
978 If true, this is equivalent to the \-\-verify\-signatures command line option\&. See
979 \fBgit-merge\fR(1)
980 for details\&.
983 merge\&.branchdesc
984 .RS 4
985 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
988 merge\&.log
989 .RS 4
990 In addition to branch names, populate the log message with at most the specified number of one\-line descriptions from the actual commits that are being merged\&. Defaults to false, and true is a synonym for 20\&.
993 merge\&.suppressDest
994 .RS 4
995 By adding a glob that matches the names of integration branches to this multi\-valued configuration variable, the default merge message computed for merges into these integration branches will omit "into <branch name>" from its title\&.
997 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
998 \fBmerge\&.suppressDest\fR
999 variable defined, the default value of
1000 \fBmaster\fR
1001 is used for backward compatibility\&.
1004 merge\&.renameLimit
1005 .RS 4
1006 The number of files to consider in the exhaustive portion of rename detection during a merge\&. If not specified, defaults to the value of diff\&.renameLimit\&. If neither merge\&.renameLimit nor diff\&.renameLimit are specified, currently defaults to 7000\&. This setting has no effect if rename detection is turned off\&.
1009 merge\&.renames
1010 .RS 4
1011 Whether Git detects renames\&. If set to "false", rename detection is disabled\&. If set to "true", basic rename detection is enabled\&. Defaults to the value of diff\&.renames\&.
1014 merge\&.directoryRenames
1015 .RS 4
1016 Whether Git detects directory renames, affecting what happens at merge time to new files added to a directory on one side of history when that directory was renamed on the other side of history\&. If merge\&.directoryRenames is set to "false", directory rename detection is disabled, meaning that such new files will be left behind in the old directory\&. If set to "true", directory rename detection is enabled, meaning that such new files will be moved into the new directory\&. If set to "conflict", a conflict will be reported for such paths\&. If merge\&.renames is false, merge\&.directoryRenames is ignored and treated as false\&. Defaults to "conflict"\&.
1019 merge\&.renormalize
1020 .RS 4
1021 Tell Git that canonical representation of files in the repository has changed over time (e\&.g\&. earlier commits record text files with CRLF line endings, but recent ones use LF line endings)\&. In such a repository, Git can convert the data recorded in commits to a canonical form before performing a merge to reduce unnecessary conflicts\&. For more information, see section "Merging branches with differing checkin/checkout attributes" in
1022 \fBgitattributes\fR(5)\&.
1025 merge\&.stat
1026 .RS 4
1027 Whether to print the diffstat between ORIG_HEAD and the merge result at the end of the merge\&. True by default\&.
1030 merge\&.autoStash
1031 .RS 4
1032 When set to true, automatically create a temporary stash entry before the operation begins, and apply it after the operation ends\&. This means that you can run merge on a dirty worktree\&. However, use with care: the final stash application after a successful merge might result in non\-trivial conflicts\&. This option can be overridden by the
1033 \fB\-\-no\-autostash\fR
1035 \fB\-\-autostash\fR
1036 options of
1037 \fBgit-merge\fR(1)\&. Defaults to false\&.
1040 merge\&.tool
1041 .RS 4
1042 Controls which merge tool is used by
1043 \fBgit-mergetool\fR(1)\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom merge tool and requires that a corresponding mergetool\&.<tool>\&.cmd variable is defined\&.
1046 merge\&.guitool
1047 .RS 4
1048 Controls which merge tool is used by
1049 \fBgit-mergetool\fR(1)
1050 when the \-g/\-\-gui flag is specified\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom merge tool and requires that a corresponding mergetool\&.<guitool>\&.cmd variable is defined\&.
1052 \fBaraxis\fR
1053 .RS 4
1054 Use Araxis Merge (requires a graphical session)
1057 \fBbc\fR
1058 .RS 4
1059 Use Beyond Compare (requires a graphical session)
1062 \fBbc3\fR
1063 .RS 4
1064 Use Beyond Compare (requires a graphical session)
1067 \fBbc4\fR
1068 .RS 4
1069 Use Beyond Compare (requires a graphical session)
1072 \fBcodecompare\fR
1073 .RS 4
1074 Use Code Compare (requires a graphical session)
1077 \fBdeltawalker\fR
1078 .RS 4
1079 Use DeltaWalker (requires a graphical session)
1082 \fBdiffmerge\fR
1083 .RS 4
1084 Use DiffMerge (requires a graphical session)
1087 \fBdiffuse\fR
1088 .RS 4
1089 Use Diffuse (requires a graphical session)
1092 \fBecmerge\fR
1093 .RS 4
1094 Use ECMerge (requires a graphical session)
1097 \fBemerge\fR
1098 .RS 4
1099 Use Emacs\(aq Emerge
1102 \fBexamdiff\fR
1103 .RS 4
1104 Use ExamDiff Pro (requires a graphical session)
1107 \fBguiffy\fR
1108 .RS 4
1109 Use Guiffy\(cqs Diff Tool (requires a graphical session)
1112 \fBgvimdiff\fR
1113 .RS 4
1114 Use gVim (requires a graphical session) with a custom layout (see
1115 \fBgit help mergetool\fR\(aqs
1116 \fBBACKEND SPECIFIC HINTS\fR
1117 section)
1120 \fBgvimdiff1\fR
1121 .RS 4
1122 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
1125 \fBgvimdiff2\fR
1126 .RS 4
1127 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
1130 \fBgvimdiff3\fR
1131 .RS 4
1132 Use gVim (requires a graphical session) where only the MERGED file is shown
1135 \fBkdiff3\fR
1136 .RS 4
1137 Use KDiff3 (requires a graphical session)
1140 \fBmeld\fR
1141 .RS 4
1142 Use Meld (requires a graphical session) with optional
1143 \fBauto merge\fR
1144 (see
1145 \fBgit help mergetool\fR\(aqs
1146 \fBCONFIGURATION\fR
1147 section)
1150 \fBnvimdiff\fR
1151 .RS 4
1152 Use Neovim with a custom layout (see
1153 \fBgit help mergetool\fR\(aqs
1154 \fBBACKEND SPECIFIC HINTS\fR
1155 section)
1158 \fBnvimdiff1\fR
1159 .RS 4
1160 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
1163 \fBnvimdiff2\fR
1164 .RS 4
1165 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
1168 \fBnvimdiff3\fR
1169 .RS 4
1170 Use Neovim where only the MERGED file is shown
1173 \fBopendiff\fR
1174 .RS 4
1175 Use FileMerge (requires a graphical session)
1178 \fBp4merge\fR
1179 .RS 4
1180 Use HelixCore P4Merge (requires a graphical session)
1183 \fBsmerge\fR
1184 .RS 4
1185 Use Sublime Merge (requires a graphical session)
1188 \fBtkdiff\fR
1189 .RS 4
1190 Use TkDiff (requires a graphical session)
1193 \fBtortoisemerge\fR
1194 .RS 4
1195 Use TortoiseMerge (requires a graphical session)
1198 \fBvimdiff\fR
1199 .RS 4
1200 Use Vim with a custom layout (see
1201 \fBgit help mergetool\fR\(aqs
1202 \fBBACKEND SPECIFIC HINTS\fR
1203 section)
1206 \fBvimdiff1\fR
1207 .RS 4
1208 Use Vim with a 2 panes layout (LOCAL and REMOTE)
1211 \fBvimdiff2\fR
1212 .RS 4
1213 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
1216 \fBvimdiff3\fR
1217 .RS 4
1218 Use Vim where only the MERGED file is shown
1221 \fBwinmerge\fR
1222 .RS 4
1223 Use WinMerge (requires a graphical session)
1226 \fBxxdiff\fR
1227 .RS 4
1228 Use xxdiff (requires a graphical session)
1232 merge\&.verbosity
1233 .RS 4
1234 Controls the amount of output shown by the recursive merge strategy\&. Level 0 outputs nothing except a final error message if conflicts were detected\&. Level 1 outputs only conflicts, 2 outputs conflicts and file changes\&. Level 5 and above outputs debugging information\&. The default is level 2\&. Can be overridden by the
1235 \fBGIT_MERGE_VERBOSITY\fR
1236 environment variable\&.
1239 merge\&.<driver>\&.name
1240 .RS 4
1241 Defines a human\-readable name for a custom low\-level merge driver\&. See
1242 \fBgitattributes\fR(5)
1243 for details\&.
1246 merge\&.<driver>\&.driver
1247 .RS 4
1248 Defines the command that implements a custom low\-level merge driver\&. See
1249 \fBgitattributes\fR(5)
1250 for details\&.
1253 merge\&.<driver>\&.recursive
1254 .RS 4
1255 Names a low\-level merge driver to be used when performing an internal merge between common ancestors\&. See
1256 \fBgitattributes\fR(5)
1257 for details\&.
1259 .SH "SEE ALSO"
1261 \fBgit-fmt-merge-msg\fR(1), \fBgit-pull\fR(1), \fBgitattributes\fR(5), \fBgit-reset\fR(1), \fBgit-diff\fR(1), \fBgit-ls-files\fR(1), \fBgit-add\fR(1), \fBgit-rm\fR(1), \fBgit-mergetool\fR(1)
1262 .SH "GIT"
1264 Part of the \fBgit\fR(1) suite