Autogenerated manpages for v2.34.1-428-gdcc0c
[git-manpages.git] / man1 / git-merge.1
blob2e53a8c407986bf5bb93b8073d5b62ee2740b46b
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: 01/03/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.34.1.428.gdcc0cd074f
8 .\"  Language: English
9 .\"
10 .TH "GIT\-MERGE" "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-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>] [<commit>\&...]
39 \fIgit merge\fR (\-\-continue | \-\-abort | \-\-quit)
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 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\&.
45 .sp
46 Assume the following history exists and the current branch is "\fBmaster\fR":
47 .sp
48 .if n \{\
49 .RS 4
50 .\}
51 .nf
52           A\-\-\-B\-\-\-C topic
53          /
54     D\-\-\-E\-\-\-F\-\-\-G master
55 .fi
56 .if n \{\
57 .RE
58 .\}
59 .sp
60 .sp
61 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\&.
62 .sp
63 .if n \{\
64 .RS 4
65 .\}
66 .nf
67           A\-\-\-B\-\-\-C topic
68          /         \e
69     D\-\-\-E\-\-\-F\-\-\-G\-\-\-H master
70 .fi
71 .if n \{\
72 .RE
73 .\}
74 .sp
75 .sp
76 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:
77 .sp
78 \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\&.
79 .sp
80 The third syntax ("\fBgit merge \-\-continue\fR") can only be run after the merge has resulted in conflicts\&.
81 .SH "OPTIONS"
82 .PP
83 \-\-commit, \-\-no\-commit
84 .RS 4
85 Perform the merge and commit the result\&. This option can be used to override \-\-no\-commit\&.
86 .sp
87 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\&.
88 .sp
89 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\&.
90 .RE
91 .PP
92 \-\-edit, \-e, \-\-no\-edit
93 .RS 4
94 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
95 \fB\-\-no\-edit\fR
96 option can be used to accept the auto\-generated message (this is generally discouraged)\&. The
97 \fB\-\-edit\fR
98 (or
99 \fB\-e\fR) option is still useful if you are giving a draft message with the
100 \fB\-m\fR
101 option from the command line and want to edit it in the editor\&.
103 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
104 \fBgit merge\fR\&. To make it easier to adjust such scripts to the updated behaviour, the environment variable
105 \fBGIT_MERGE_AUTOEDIT\fR
106 can be set to
107 \fBno\fR
108 at the beginning of them\&.
111 \-\-cleanup=<mode>
112 .RS 4
113 This option determines how the merge message will be cleaned up before committing\&. See
114 \fBgit-commit\fR(1)
115 for more details\&. In addition, if the
116 \fI<mode>\fR
117 is given a value of
118 \fBscissors\fR, scissors will be appended to
119 \fBMERGE_MSG\fR
120 before being passed on to the commit machinery in the case of a merge conflict\&.
123 \-\-ff, \-\-no\-ff, \-\-ff\-only
124 .RS 4
125 Specifies how a merge is handled when the merged\-in history is already a descendant of the current history\&.
126 \fB\-\-ff\fR
127 is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the
128 \fBrefs/tags/\fR
129 hierarchy, in which case
130 \fB\-\-no\-ff\fR
131 is assumed\&.
133 With
134 \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\&.
136 With
137 \fB\-\-no\-ff\fR, create a merge commit in all cases, even when the merge could instead be resolved as a fast\-forward\&.
139 With
140 \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\&.
143 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
144 .RS 4
145 GPG\-sign the resulting merge commit\&. The
146 \fBkeyid\fR
147 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
148 \fB\-\-no\-gpg\-sign\fR
149 is useful to countermand both
150 \fBcommit\&.gpgSign\fR
151 configuration variable, and earlier
152 \fB\-\-gpg\-sign\fR\&.
155 \-\-log[=<n>], \-\-no\-log
156 .RS 4
157 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
158 \fBgit-fmt-merge-msg\fR(1)\&.
160 With \-\-no\-log do not list one\-line descriptions from the actual commits being merged\&.
163 \-\-signoff, \-\-no\-signoff
164 .RS 4
165 Add a
166 \fBSigned\-off\-by\fR
167 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
168 \m[blue]\fBhttp://developercertificate\&.org\fR\m[]
169 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\&.
171 The \-\-no\-signoff option can be used to countermand an earlier \-\-signoff option on the command line\&.
174 \-\-stat, \-n, \-\-no\-stat
175 .RS 4
176 Show a diffstat at the end of the merge\&. The diffstat is also controlled by the configuration option merge\&.stat\&.
178 With \-n or \-\-no\-stat do not show a diffstat at the end of the merge\&.
181 \-\-squash, \-\-no\-squash
182 .RS 4
183 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
184 \fBHEAD\fR, or record
185 \fB$GIT_DIR/MERGE_HEAD\fR
186 (to cause the next
187 \fBgit commit\fR
188 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)\&.
190 With \-\-no\-squash perform the merge and commit the result\&. This option can be used to override \-\-squash\&.
192 With \-\-squash, \-\-commit is not allowed, and will fail\&.
195 \-\-[no\-]verify
196 .RS 4
197 By default, the pre\-merge and commit\-msg hooks are run\&. When
198 \fB\-\-no\-verify\fR
199 is given, these are bypassed\&. See also
200 \fBgithooks\fR(5)\&.
203 \-s <strategy>, \-\-strategy=<strategy>
204 .RS 4
205 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
206 \fB\-s\fR
207 option, a built\-in list of strategies is used instead (\fBort\fR
208 when merging a single head,
209 \fBoctopus\fR
210 otherwise)\&.
213 \-X <option>, \-\-strategy\-option=<option>
214 .RS 4
215 Pass merge strategy specific option through to the merge strategy\&.
218 \-\-verify\-signatures, \-\-no\-verify\-signatures
219 .RS 4
220 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\&.
223 \-\-summary, \-\-no\-summary
224 .RS 4
225 Synonyms to \-\-stat and \-\-no\-stat; these are deprecated and will be removed in the future\&.
228 \-q, \-\-quiet
229 .RS 4
230 Operate quietly\&. Implies \-\-no\-progress\&.
233 \-v, \-\-verbose
234 .RS 4
235 Be verbose\&.
238 \-\-progress, \-\-no\-progress
239 .RS 4
240 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\&.
243 \-\-autostash, \-\-no\-autostash
244 .RS 4
245 Automatically create a temporary stash entry before the operation begins, record it in the special ref
246 \fBMERGE_AUTOSTASH\fR
247 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\&.
250 \-\-allow\-unrelated\-histories
251 .RS 4
252 By default,
253 \fBgit merge\fR
254 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\&.
257 \-m <msg>
258 .RS 4
259 Set the commit message to be used for the merge commit (in case one is created)\&.
262 \fB\-\-log\fR
263 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
266 \fIgit fmt\-merge\-msg\fR
267 command can be used to give a good default for automated
268 \fIgit merge\fR
269 invocations\&. The automated message can include the branch description\&.
272 \-F <file>, \-\-file=<file>
273 .RS 4
274 Read the commit message to be used for the merge commit (in case one is created)\&.
277 \fB\-\-log\fR
278 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
281 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
282 .RS 4
283 Allow the rerere mechanism to update the index with the result of auto\-conflict resolution if possible\&.
286 \-\-overwrite\-ignore, \-\-no\-overwrite\-ignore
287 .RS 4
288 Silently overwrite ignored files from the merge result\&. This is the default behavior\&. Use
289 \fB\-\-no\-overwrite\-ignore\fR
290 to abort\&.
293 \-\-abort
294 .RS 4
295 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\&.
297 If there were uncommitted worktree changes present when the merge started,
298 \fIgit merge \-\-abort\fR
299 will in some cases be unable to reconstruct these changes\&. It is therefore recommended to always commit or stash your changes before running
300 \fIgit merge\fR\&.
302 \fIgit merge \-\-abort\fR
303 is equivalent to
304 \fIgit reset \-\-merge\fR
305 when
306 \fBMERGE_HEAD\fR
307 is present unless
308 \fBMERGE_AUTOSTASH\fR
309 is also present in which case
310 \fIgit merge \-\-abort\fR
311 applies the stash entry to the worktree whereas
312 \fIgit reset \-\-merge\fR
313 will save the stashed changes in the stash list\&.
316 \-\-quit
317 .RS 4
318 Forget about the current merge in progress\&. Leave the index and the working tree as\-is\&. If
319 \fBMERGE_AUTOSTASH\fR
320 is present, the stash entry will be saved to the stash list\&.
323 \-\-continue
324 .RS 4
325 After a
326 \fIgit merge\fR
327 stops due to conflicts you can conclude the merge by running
328 \fIgit merge \-\-continue\fR
329 (see "HOW TO RESOLVE CONFLICTS" section below)\&.
332 <commit>\&...
333 .RS 4
334 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)\&.
336 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\&.
338 When
339 \fBFETCH_HEAD\fR
340 (and no other commit) is specified, the branches recorded in the
341 \fB\&.git/FETCH_HEAD\fR
342 file by the previous invocation of
343 \fBgit fetch\fR
344 for merging are merged to the current branch\&.
346 .SH "PRE\-MERGE CHECKS"
348 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\&.
350 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\&.)
352 If all named commits are already ancestors of \fBHEAD\fR, \fIgit merge\fR will exit early with the message "Already up to date\&."
353 .SH "FAST\-FORWARD MERGE"
355 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\&.
357 This behavior can be suppressed with the \fB\-\-no\-ff\fR option\&.
358 .SH "TRUE MERGE"
360 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\&.
362 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\&.
364 When it is not obvious how to reconcile the changes, the following happens:
366 .RS 4
367 .ie n \{\
368 \h'-04' 1.\h'+01'\c
370 .el \{\
371 .sp -1
372 .IP "  1." 4.2
375 \fBHEAD\fR
376 pointer stays the same\&.
379 .RS 4
380 .ie n \{\
381 \h'-04' 2.\h'+01'\c
383 .el \{\
384 .sp -1
385 .IP "  2." 4.2
388 \fBMERGE_HEAD\fR
389 ref is set to point to the other branch head\&.
392 .RS 4
393 .ie n \{\
394 \h'-04' 3.\h'+01'\c
396 .el \{\
397 .sp -1
398 .IP "  3." 4.2
400 Paths that merged cleanly are updated both in the index file and in your working tree\&.
403 .RS 4
404 .ie n \{\
405 \h'-04' 4.\h'+01'\c
407 .el \{\
408 .sp -1
409 .IP "  4." 4.2
411 For conflicting paths, the index file records up to three versions: stage 1 stores the version from the common ancestor, stage 2 from
412 \fBHEAD\fR, and stage 3 from
413 \fBMERGE_HEAD\fR
414 (you can inspect the stages with
415 \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
416 \fB<<<\fR
417 \fB===\fR
418 \fB>>>\fR\&.
421 .RS 4
422 .ie n \{\
423 \h'-04' 5.\h'+01'\c
425 .el \{\
426 .sp -1
427 .IP "  5." 4.2
429 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
430 \fBHEAD\fR\&.
433 If you tried a merge which resulted in complex conflicts and want to start over, you can recover with \fBgit merge \-\-abort\fR\&.
434 .SH "MERGING TAG"
436 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)\&.
438 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\&.
440 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\&.
442 .if n \{\
443 .RS 4
446 git fetch origin
447 git merge v1\&.2\&.3^0
448 git merge \-\-ff\-only v1\&.2\&.3
450 .if n \{\
454 .SH "HOW CONFLICTS ARE PRESENTED"
456 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\&.
458 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:
460 .if n \{\
461 .RS 4
464 Here are lines that are either unchanged from the common
465 ancestor, or cleanly resolved because only one side changed,
466 or cleanly resolved because both sides changed the same way\&.
467 <<<<<<< yours:sample\&.txt
468 Conflict resolution is hard;
469 let\(aqs go shopping\&.
470 =======
471 Git makes conflict resolution easy\&.
472 >>>>>>> theirs:sample\&.txt
473 And here is another line that is cleanly resolved or unmodified\&.
475 .if n \{\
480 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\&.
482 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\&.
484 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:
486 .if n \{\
487 .RS 4
490 Here are lines that are either unchanged from the common
491 ancestor, or cleanly resolved because only one side changed,
492 <<<<<<< yours:sample\&.txt
493 or cleanly resolved because both sides changed the same way\&.
494 Conflict resolution is hard;
495 let\(aqs go shopping\&.
496 ||||||| base:sample\&.txt
497 or cleanly resolved because both sides changed identically\&.
498 Conflict resolution is hard\&.
499 =======
500 or cleanly resolved because both sides changed the same way\&.
501 Git makes conflict resolution easy\&.
502 >>>>>>> theirs:sample\&.txt
503 And here is another line that is cleanly resolved or unmodified\&.
505 .if n \{\
510 while in "zdiff3" style, it may look like this:
512 .if n \{\
513 .RS 4
516 Here are lines that are either unchanged from the common
517 ancestor, or cleanly resolved because only one side changed,
518 or cleanly resolved because both sides changed the same way\&.
519 <<<<<<< yours:sample\&.txt
520 Conflict resolution is hard;
521 let\(aqs go shopping\&.
522 ||||||| base:sample\&.txt
523 or cleanly resolved because both sides changed identically\&.
524 Conflict resolution is hard\&.
525 =======
526 Git makes conflict resolution easy\&.
527 >>>>>>> theirs:sample\&.txt
528 And here is another line that is cleanly resolved or unmodified\&.
530 .if n \{\
535 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\&.
536 .SH "HOW TO RESOLVE CONFLICTS"
538 After seeing a conflict, you can do two things:
540 .RS 4
541 .ie n \{\
542 \h'-04'\(bu\h'+03'\c
544 .el \{\
545 .sp -1
546 .IP \(bu 2.3
548 Decide not to merge\&. The only clean\-ups you need are to reset the index file to the
549 \fBHEAD\fR
550 commit to reverse 2\&. and to clean up working tree changes made by 2\&. and 3\&.;
551 \fBgit merge \-\-abort\fR
552 can be used for this\&.
555 .RS 4
556 .ie n \{\
557 \h'-04'\(bu\h'+03'\c
559 .el \{\
560 .sp -1
561 .IP \(bu 2.3
563 Resolve the conflicts\&. Git will mark the conflicts in the working tree\&. Edit the files into shape and
564 \fIgit add\fR
565 them to the index\&. Use
566 \fIgit commit\fR
568 \fIgit merge \-\-continue\fR
569 to seal the deal\&. The latter command checks whether there is a (interrupted) merge in progress before calling
570 \fIgit commit\fR\&.
573 You can work through the conflict with a number of tools:
575 .RS 4
576 .ie n \{\
577 \h'-04'\(bu\h'+03'\c
579 .el \{\
580 .sp -1
581 .IP \(bu 2.3
583 Use a mergetool\&.
584 \fBgit mergetool\fR
585 to launch a graphical mergetool which will work you through the merge\&.
588 .RS 4
589 .ie n \{\
590 \h'-04'\(bu\h'+03'\c
592 .el \{\
593 .sp -1
594 .IP \(bu 2.3
596 Look at the diffs\&.
597 \fBgit diff\fR
598 will show a three\-way diff, highlighting changes from both the
599 \fBHEAD\fR
601 \fBMERGE_HEAD\fR
602 versions\&.
605 .RS 4
606 .ie n \{\
607 \h'-04'\(bu\h'+03'\c
609 .el \{\
610 .sp -1
611 .IP \(bu 2.3
613 Look at the diffs from each branch\&.
614 \fBgit log \-\-merge \-p <path>\fR
615 will show diffs first for the
616 \fBHEAD\fR
617 version and then the
618 \fBMERGE_HEAD\fR
619 version\&.
622 .RS 4
623 .ie n \{\
624 \h'-04'\(bu\h'+03'\c
626 .el \{\
627 .sp -1
628 .IP \(bu 2.3
630 Look at the originals\&.
631 \fBgit show :1:filename\fR
632 shows the common ancestor,
633 \fBgit show :2:filename\fR
634 shows the
635 \fBHEAD\fR
636 version, and
637 \fBgit show :3:filename\fR
638 shows the
639 \fBMERGE_HEAD\fR
640 version\&.
642 .SH "EXAMPLES"
644 .RS 4
645 .ie n \{\
646 \h'-04'\(bu\h'+03'\c
648 .el \{\
649 .sp -1
650 .IP \(bu 2.3
652 Merge branches
653 \fBfixes\fR
655 \fBenhancements\fR
656 on top of the current branch, making an octopus merge:
658 .if n \{\
659 .RS 4
662 $ git merge fixes enhancements
664 .if n \{\
670 .RS 4
671 .ie n \{\
672 \h'-04'\(bu\h'+03'\c
674 .el \{\
675 .sp -1
676 .IP \(bu 2.3
678 Merge branch
679 \fBobsolete\fR
680 into the current branch, using
681 \fBours\fR
682 merge strategy:
684 .if n \{\
685 .RS 4
688 $ git merge \-s ours obsolete
690 .if n \{\
696 .RS 4
697 .ie n \{\
698 \h'-04'\(bu\h'+03'\c
700 .el \{\
701 .sp -1
702 .IP \(bu 2.3
704 Merge branch
705 \fBmaint\fR
706 into the current branch, but do not make a new commit automatically:
708 .if n \{\
709 .RS 4
712 $ git merge \-\-no\-commit maint
714 .if n \{\
718 This can be used when you want to include further changes to the merge, or want to write your own merge commit message\&.
720 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\&.
722 .SH "MERGE STRATEGIES"
724 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\&.
727 .RS 4
728 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,
729 \fBrecursive\fR\&.
732 \fIort\fR
733 strategy can take the following options:
735 ours
736 .RS 4
737 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
738 \fIour\fR
739 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\&.
741 This should not be confused with the
742 \fIours\fR
743 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
744 \fIour\fR
745 history contains all that happened in it\&.
748 theirs
749 .RS 4
750 This is the opposite of
751 \fIours\fR; note that, unlike
752 \fIours\fR, there is no
753 \fItheirs\fR
754 merge strategy to confuse this merge option with\&.
757 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
758 .RS 4
759 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
760 \fBgit-diff\fR(1)
761 \fB\-b\fR,
762 \fB\-w\fR,
763 \fB\-\-ignore\-space\-at\-eol\fR, and
764 \fB\-\-ignore\-cr\-at\-eol\fR\&.
766 .RS 4
767 .ie n \{\
768 \h'-04'\(bu\h'+03'\c
770 .el \{\
771 .sp -1
772 .IP \(bu 2.3
775 \fItheir\fR
776 version only introduces whitespace changes to a line,
777 \fIour\fR
778 version is used;
781 .RS 4
782 .ie n \{\
783 \h'-04'\(bu\h'+03'\c
785 .el \{\
786 .sp -1
787 .IP \(bu 2.3
790 \fIour\fR
791 version introduces whitespace changes but
792 \fItheir\fR
793 version includes a substantial change,
794 \fItheir\fR
795 version is used;
798 .RS 4
799 .ie n \{\
800 \h'-04'\(bu\h'+03'\c
802 .el \{\
803 .sp -1
804 .IP \(bu 2.3
806 Otherwise, the merge proceeds in the usual way\&.
810 renormalize
811 .RS 4
812 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
813 \fBgitattributes\fR(5)
814 for details\&.
817 no\-renormalize
818 .RS 4
819 Disables the
820 \fBrenormalize\fR
821 option\&. This overrides the
822 \fBmerge\&.renormalize\fR
823 configuration variable\&.
826 find\-renames[=<n>]
827 .RS 4
828 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
829 \fImerge\&.renames\fR
830 configuration variable\&. See also
831 \fBgit-diff\fR(1)
832 \fB\-\-find\-renames\fR\&.
835 rename\-threshold=<n>
836 .RS 4
837 Deprecated synonym for
838 \fBfind\-renames=<n>\fR\&.
841 subtree[=<path>]
842 .RS 4
843 This option is a more advanced form of
844 \fIsubtree\fR
845 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\&.
849 recursive
850 .RS 4
851 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\&.
854 \fIrecursive\fR
855 strategy takes the same options as
856 \fIort\fR\&. However, there are three additional options that
857 \fIort\fR
858 ignores (not documented above) that are potentially useful with the
859 \fIrecursive\fR
860 strategy:
862 patience
863 .RS 4
864 Deprecated synonym for
865 \fBdiff\-algorithm=patience\fR\&.
868 diff\-algorithm=[patience|minimal|histogram|myers]
869 .RS 4
870 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
871 \fBgit-diff\fR(1)
872 \fB\-\-diff\-algorithm\fR\&. Note that
873 \fBort\fR
874 specifically uses
875 \fBdiff\-algorithm=histogram\fR, while
876 \fBrecursive\fR
877 defaults to the
878 \fBdiff\&.algorithm\fR
879 config setting\&.
882 no\-renames
883 .RS 4
884 Turn off rename detection\&. This overrides the
885 \fBmerge\&.renames\fR
886 configuration variable\&. See also
887 \fBgit-diff\fR(1)
888 \fB\-\-no\-renames\fR\&.
892 resolve
893 .RS 4
894 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\&.
897 octopus
898 .RS 4
899 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\&.
902 ours
903 .RS 4
904 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
905 \fIrecursive\fR
906 merge strategy\&.
909 subtree
910 .RS 4
911 This is a modified
912 \fBort\fR
913 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\&.
916 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\&.
917 .SH "CONFIGURATION"
919 merge\&.conflictStyle
920 .RS 4
921 Specify the style in which conflicted hunks are written out to working tree files upon merge\&. The default is "merge", which shows a
922 \fB<<<<<<<\fR
923 conflict marker, changes made by one side, a
924 \fB=======\fR
925 marker, changes made by the other side, and then a
926 \fB>>>>>>>\fR
927 marker\&. An alternate style, "diff3", adds a
928 \fB|||||||\fR
929 marker and the original text before the
930 \fB=======\fR
931 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\&.
934 merge\&.defaultToUpstream
935 .RS 4
936 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
937 \fBbranch\&.<current branch>\&.merge\fR
938 that name the branches at the remote named by
939 \fBbranch\&.<current branch>\&.remote\fR
940 are consulted, and then they are mapped via
941 \fBremote\&.<remote>\&.fetch\fR
942 to their corresponding remote\-tracking branches, and the tips of these tracking branches are merged\&. Defaults to true\&.
945 merge\&.ff
946 .RS 4
947 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
948 \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
949 \fB\-\-no\-ff\fR
950 option from the command line)\&. When set to
951 \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
952 \fB\-\-ff\-only\fR
953 option from the command line)\&.
956 merge\&.verifySignatures
957 .RS 4
958 If true, this is equivalent to the \-\-verify\-signatures command line option\&. See
959 \fBgit-merge\fR(1)
960 for details\&.
963 merge\&.branchdesc
964 .RS 4
965 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
968 merge\&.log
969 .RS 4
970 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\&.
973 merge\&.suppressDest
974 .RS 4
975 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\&.
977 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
978 \fBmerge\&.suppressDest\fR
979 variable defined, the default value of
980 \fBmaster\fR
981 is used for backward compatibility\&.
984 merge\&.renameLimit
985 .RS 4
986 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\&.
989 merge\&.renames
990 .RS 4
991 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\&.
994 merge\&.directoryRenames
995 .RS 4
996 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"\&.
999 merge\&.renormalize
1000 .RS 4
1001 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
1002 \fBgitattributes\fR(5)\&.
1005 merge\&.stat
1006 .RS 4
1007 Whether to print the diffstat between ORIG_HEAD and the merge result at the end of the merge\&. True by default\&.
1010 merge\&.autoStash
1011 .RS 4
1012 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
1013 \fB\-\-no\-autostash\fR
1015 \fB\-\-autostash\fR
1016 options of
1017 \fBgit-merge\fR(1)\&. Defaults to false\&.
1020 merge\&.tool
1021 .RS 4
1022 Controls which merge tool is used by
1023 \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\&.
1026 merge\&.guitool
1027 .RS 4
1028 Controls which merge tool is used by
1029 \fBgit-mergetool\fR(1)
1030 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\&.
1032 .RS 4
1033 .ie n \{\
1034 \h'-04'\(bu\h'+03'\c
1036 .el \{\
1037 .sp -1
1038 .IP \(bu 2.3
1040 araxis
1043 .RS 4
1044 .ie n \{\
1045 \h'-04'\(bu\h'+03'\c
1047 .el \{\
1048 .sp -1
1049 .IP \(bu 2.3
1054 .RS 4
1055 .ie n \{\
1056 \h'-04'\(bu\h'+03'\c
1058 .el \{\
1059 .sp -1
1060 .IP \(bu 2.3
1065 .RS 4
1066 .ie n \{\
1067 \h'-04'\(bu\h'+03'\c
1069 .el \{\
1070 .sp -1
1071 .IP \(bu 2.3
1076 .RS 4
1077 .ie n \{\
1078 \h'-04'\(bu\h'+03'\c
1080 .el \{\
1081 .sp -1
1082 .IP \(bu 2.3
1084 codecompare
1087 .RS 4
1088 .ie n \{\
1089 \h'-04'\(bu\h'+03'\c
1091 .el \{\
1092 .sp -1
1093 .IP \(bu 2.3
1095 deltawalker
1098 .RS 4
1099 .ie n \{\
1100 \h'-04'\(bu\h'+03'\c
1102 .el \{\
1103 .sp -1
1104 .IP \(bu 2.3
1106 diffmerge
1109 .RS 4
1110 .ie n \{\
1111 \h'-04'\(bu\h'+03'\c
1113 .el \{\
1114 .sp -1
1115 .IP \(bu 2.3
1117 diffuse
1120 .RS 4
1121 .ie n \{\
1122 \h'-04'\(bu\h'+03'\c
1124 .el \{\
1125 .sp -1
1126 .IP \(bu 2.3
1128 ecmerge
1131 .RS 4
1132 .ie n \{\
1133 \h'-04'\(bu\h'+03'\c
1135 .el \{\
1136 .sp -1
1137 .IP \(bu 2.3
1139 emerge
1142 .RS 4
1143 .ie n \{\
1144 \h'-04'\(bu\h'+03'\c
1146 .el \{\
1147 .sp -1
1148 .IP \(bu 2.3
1150 examdiff
1153 .RS 4
1154 .ie n \{\
1155 \h'-04'\(bu\h'+03'\c
1157 .el \{\
1158 .sp -1
1159 .IP \(bu 2.3
1161 guiffy
1164 .RS 4
1165 .ie n \{\
1166 \h'-04'\(bu\h'+03'\c
1168 .el \{\
1169 .sp -1
1170 .IP \(bu 2.3
1172 gvimdiff
1175 .RS 4
1176 .ie n \{\
1177 \h'-04'\(bu\h'+03'\c
1179 .el \{\
1180 .sp -1
1181 .IP \(bu 2.3
1183 gvimdiff1
1186 .RS 4
1187 .ie n \{\
1188 \h'-04'\(bu\h'+03'\c
1190 .el \{\
1191 .sp -1
1192 .IP \(bu 2.3
1194 gvimdiff2
1197 .RS 4
1198 .ie n \{\
1199 \h'-04'\(bu\h'+03'\c
1201 .el \{\
1202 .sp -1
1203 .IP \(bu 2.3
1205 gvimdiff3
1208 .RS 4
1209 .ie n \{\
1210 \h'-04'\(bu\h'+03'\c
1212 .el \{\
1213 .sp -1
1214 .IP \(bu 2.3
1216 kdiff3
1219 .RS 4
1220 .ie n \{\
1221 \h'-04'\(bu\h'+03'\c
1223 .el \{\
1224 .sp -1
1225 .IP \(bu 2.3
1227 meld
1230 .RS 4
1231 .ie n \{\
1232 \h'-04'\(bu\h'+03'\c
1234 .el \{\
1235 .sp -1
1236 .IP \(bu 2.3
1238 nvimdiff
1241 .RS 4
1242 .ie n \{\
1243 \h'-04'\(bu\h'+03'\c
1245 .el \{\
1246 .sp -1
1247 .IP \(bu 2.3
1249 nvimdiff1
1252 .RS 4
1253 .ie n \{\
1254 \h'-04'\(bu\h'+03'\c
1256 .el \{\
1257 .sp -1
1258 .IP \(bu 2.3
1260 nvimdiff2
1263 .RS 4
1264 .ie n \{\
1265 \h'-04'\(bu\h'+03'\c
1267 .el \{\
1268 .sp -1
1269 .IP \(bu 2.3
1271 nvimdiff3
1274 .RS 4
1275 .ie n \{\
1276 \h'-04'\(bu\h'+03'\c
1278 .el \{\
1279 .sp -1
1280 .IP \(bu 2.3
1282 opendiff
1285 .RS 4
1286 .ie n \{\
1287 \h'-04'\(bu\h'+03'\c
1289 .el \{\
1290 .sp -1
1291 .IP \(bu 2.3
1293 p4merge
1296 .RS 4
1297 .ie n \{\
1298 \h'-04'\(bu\h'+03'\c
1300 .el \{\
1301 .sp -1
1302 .IP \(bu 2.3
1304 smerge
1307 .RS 4
1308 .ie n \{\
1309 \h'-04'\(bu\h'+03'\c
1311 .el \{\
1312 .sp -1
1313 .IP \(bu 2.3
1315 tkdiff
1318 .RS 4
1319 .ie n \{\
1320 \h'-04'\(bu\h'+03'\c
1322 .el \{\
1323 .sp -1
1324 .IP \(bu 2.3
1326 tortoisemerge
1329 .RS 4
1330 .ie n \{\
1331 \h'-04'\(bu\h'+03'\c
1333 .el \{\
1334 .sp -1
1335 .IP \(bu 2.3
1337 vimdiff
1340 .RS 4
1341 .ie n \{\
1342 \h'-04'\(bu\h'+03'\c
1344 .el \{\
1345 .sp -1
1346 .IP \(bu 2.3
1348 vimdiff1
1351 .RS 4
1352 .ie n \{\
1353 \h'-04'\(bu\h'+03'\c
1355 .el \{\
1356 .sp -1
1357 .IP \(bu 2.3
1359 vimdiff2
1362 .RS 4
1363 .ie n \{\
1364 \h'-04'\(bu\h'+03'\c
1366 .el \{\
1367 .sp -1
1368 .IP \(bu 2.3
1370 vimdiff3
1373 .RS 4
1374 .ie n \{\
1375 \h'-04'\(bu\h'+03'\c
1377 .el \{\
1378 .sp -1
1379 .IP \(bu 2.3
1381 winmerge
1384 .RS 4
1385 .ie n \{\
1386 \h'-04'\(bu\h'+03'\c
1388 .el \{\
1389 .sp -1
1390 .IP \(bu 2.3
1392 xxdiff
1396 merge\&.verbosity
1397 .RS 4
1398 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
1399 \fBGIT_MERGE_VERBOSITY\fR
1400 environment variable\&.
1403 merge\&.<driver>\&.name
1404 .RS 4
1405 Defines a human\-readable name for a custom low\-level merge driver\&. See
1406 \fBgitattributes\fR(5)
1407 for details\&.
1410 merge\&.<driver>\&.driver
1411 .RS 4
1412 Defines the command that implements a custom low\-level merge driver\&. See
1413 \fBgitattributes\fR(5)
1414 for details\&.
1417 merge\&.<driver>\&.recursive
1418 .RS 4
1419 Names a low\-level merge driver to be used when performing an internal merge between common ancestors\&. See
1420 \fBgitattributes\fR(5)
1421 for details\&.
1424 branch\&.<name>\&.mergeOptions
1425 .RS 4
1426 Sets default options for merging into branch <name>\&. The syntax and supported options are the same as those of
1427 \fIgit merge\fR, but option values containing whitespace characters are currently not supported\&.
1429 .SH "SEE ALSO"
1431 \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)
1432 .SH "GIT"
1434 Part of the \fBgit\fR(1) suite