Autogenerated manpages for v2.34.1-8-g35151
[git-manpages.git] / man1 / git-merge.1
blobdf8d08c544422fe9926e82b2a468098f822c6465
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: 11/24/2021
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.34.1.8.g35151cf072
8 .\"  Language: English
9 .\"
10 .TH "GIT\-MERGE" "1" "11/24/2021" "Git 2\&.34\&.1\&.8\&.g35151cf0" "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 <<<<<<< yours:sample\&.txt
467 Conflict resolution is hard;
468 let\(aqs go shopping\&.
469 =======
470 Git makes conflict resolution easy\&.
471 >>>>>>> theirs:sample\&.txt
472 And here is another line that is cleanly resolved or unmodified\&.
474 .if n \{\
479 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\&.
481 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\&.
483 An alternative style can be used by setting the "merge\&.conflictStyle" configuration variable to "diff3"\&. In "diff3" style, the above conflict may look like this:
485 .if n \{\
486 .RS 4
489 Here are lines that are either unchanged from the common
490 ancestor, or cleanly resolved because only one side changed\&.
491 <<<<<<< yours:sample\&.txt
492 Conflict resolution is hard;
493 let\(aqs go shopping\&.
494 |||||||
495 Conflict resolution is hard\&.
496 =======
497 Git makes conflict resolution easy\&.
498 >>>>>>> theirs:sample\&.txt
499 And here is another line that is cleanly resolved or unmodified\&.
501 .if n \{\
506 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\&.
507 .SH "HOW TO RESOLVE CONFLICTS"
509 After seeing a conflict, you can do two things:
511 .RS 4
512 .ie n \{\
513 \h'-04'\(bu\h'+03'\c
515 .el \{\
516 .sp -1
517 .IP \(bu 2.3
519 Decide not to merge\&. The only clean\-ups you need are to reset the index file to the
520 \fBHEAD\fR
521 commit to reverse 2\&. and to clean up working tree changes made by 2\&. and 3\&.;
522 \fBgit merge \-\-abort\fR
523 can be used for this\&.
526 .RS 4
527 .ie n \{\
528 \h'-04'\(bu\h'+03'\c
530 .el \{\
531 .sp -1
532 .IP \(bu 2.3
534 Resolve the conflicts\&. Git will mark the conflicts in the working tree\&. Edit the files into shape and
535 \fIgit add\fR
536 them to the index\&. Use
537 \fIgit commit\fR
539 \fIgit merge \-\-continue\fR
540 to seal the deal\&. The latter command checks whether there is a (interrupted) merge in progress before calling
541 \fIgit commit\fR\&.
544 You can work through the conflict with a number of tools:
546 .RS 4
547 .ie n \{\
548 \h'-04'\(bu\h'+03'\c
550 .el \{\
551 .sp -1
552 .IP \(bu 2.3
554 Use a mergetool\&.
555 \fBgit mergetool\fR
556 to launch a graphical mergetool which will work you through the merge\&.
559 .RS 4
560 .ie n \{\
561 \h'-04'\(bu\h'+03'\c
563 .el \{\
564 .sp -1
565 .IP \(bu 2.3
567 Look at the diffs\&.
568 \fBgit diff\fR
569 will show a three\-way diff, highlighting changes from both the
570 \fBHEAD\fR
572 \fBMERGE_HEAD\fR
573 versions\&.
576 .RS 4
577 .ie n \{\
578 \h'-04'\(bu\h'+03'\c
580 .el \{\
581 .sp -1
582 .IP \(bu 2.3
584 Look at the diffs from each branch\&.
585 \fBgit log \-\-merge \-p <path>\fR
586 will show diffs first for the
587 \fBHEAD\fR
588 version and then the
589 \fBMERGE_HEAD\fR
590 version\&.
593 .RS 4
594 .ie n \{\
595 \h'-04'\(bu\h'+03'\c
597 .el \{\
598 .sp -1
599 .IP \(bu 2.3
601 Look at the originals\&.
602 \fBgit show :1:filename\fR
603 shows the common ancestor,
604 \fBgit show :2:filename\fR
605 shows the
606 \fBHEAD\fR
607 version, and
608 \fBgit show :3:filename\fR
609 shows the
610 \fBMERGE_HEAD\fR
611 version\&.
613 .SH "EXAMPLES"
615 .RS 4
616 .ie n \{\
617 \h'-04'\(bu\h'+03'\c
619 .el \{\
620 .sp -1
621 .IP \(bu 2.3
623 Merge branches
624 \fBfixes\fR
626 \fBenhancements\fR
627 on top of the current branch, making an octopus merge:
629 .if n \{\
630 .RS 4
633 $ git merge fixes enhancements
635 .if n \{\
641 .RS 4
642 .ie n \{\
643 \h'-04'\(bu\h'+03'\c
645 .el \{\
646 .sp -1
647 .IP \(bu 2.3
649 Merge branch
650 \fBobsolete\fR
651 into the current branch, using
652 \fBours\fR
653 merge strategy:
655 .if n \{\
656 .RS 4
659 $ git merge \-s ours obsolete
661 .if n \{\
667 .RS 4
668 .ie n \{\
669 \h'-04'\(bu\h'+03'\c
671 .el \{\
672 .sp -1
673 .IP \(bu 2.3
675 Merge branch
676 \fBmaint\fR
677 into the current branch, but do not make a new commit automatically:
679 .if n \{\
680 .RS 4
683 $ git merge \-\-no\-commit maint
685 .if n \{\
689 This can be used when you want to include further changes to the merge, or want to write your own merge commit message\&.
691 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\&.
693 .SH "MERGE STRATEGIES"
695 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\&.
698 .RS 4
699 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,
700 \fBrecursive\fR\&.
703 \fIort\fR
704 strategy can take the following options:
706 ours
707 .RS 4
708 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
709 \fIour\fR
710 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\&.
712 This should not be confused with the
713 \fIours\fR
714 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
715 \fIour\fR
716 history contains all that happened in it\&.
719 theirs
720 .RS 4
721 This is the opposite of
722 \fIours\fR; note that, unlike
723 \fIours\fR, there is no
724 \fItheirs\fR
725 merge strategy to confuse this merge option with\&.
728 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
729 .RS 4
730 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
731 \fBgit-diff\fR(1)
732 \fB\-b\fR,
733 \fB\-w\fR,
734 \fB\-\-ignore\-space\-at\-eol\fR, and
735 \fB\-\-ignore\-cr\-at\-eol\fR\&.
737 .RS 4
738 .ie n \{\
739 \h'-04'\(bu\h'+03'\c
741 .el \{\
742 .sp -1
743 .IP \(bu 2.3
746 \fItheir\fR
747 version only introduces whitespace changes to a line,
748 \fIour\fR
749 version is used;
752 .RS 4
753 .ie n \{\
754 \h'-04'\(bu\h'+03'\c
756 .el \{\
757 .sp -1
758 .IP \(bu 2.3
761 \fIour\fR
762 version introduces whitespace changes but
763 \fItheir\fR
764 version includes a substantial change,
765 \fItheir\fR
766 version is used;
769 .RS 4
770 .ie n \{\
771 \h'-04'\(bu\h'+03'\c
773 .el \{\
774 .sp -1
775 .IP \(bu 2.3
777 Otherwise, the merge proceeds in the usual way\&.
781 renormalize
782 .RS 4
783 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
784 \fBgitattributes\fR(5)
785 for details\&.
788 no\-renormalize
789 .RS 4
790 Disables the
791 \fBrenormalize\fR
792 option\&. This overrides the
793 \fBmerge\&.renormalize\fR
794 configuration variable\&.
797 find\-renames[=<n>]
798 .RS 4
799 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
800 \fImerge\&.renames\fR
801 configuration variable\&. See also
802 \fBgit-diff\fR(1)
803 \fB\-\-find\-renames\fR\&.
806 rename\-threshold=<n>
807 .RS 4
808 Deprecated synonym for
809 \fBfind\-renames=<n>\fR\&.
812 subtree[=<path>]
813 .RS 4
814 This option is a more advanced form of
815 \fIsubtree\fR
816 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\&.
820 recursive
821 .RS 4
822 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\&.
825 \fIrecursive\fR
826 strategy takes the same options as
827 \fIort\fR\&. However, there are three additional options that
828 \fIort\fR
829 ignores (not documented above) that are potentially useful with the
830 \fIrecursive\fR
831 strategy:
833 patience
834 .RS 4
835 Deprecated synonym for
836 \fBdiff\-algorithm=patience\fR\&.
839 diff\-algorithm=[patience|minimal|histogram|myers]
840 .RS 4
841 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
842 \fBgit-diff\fR(1)
843 \fB\-\-diff\-algorithm\fR\&. Note that
844 \fBort\fR
845 specifically uses
846 \fBdiff\-algorithm=histogram\fR, while
847 \fBrecursive\fR
848 defaults to the
849 \fBdiff\&.algorithm\fR
850 config setting\&.
853 no\-renames
854 .RS 4
855 Turn off rename detection\&. This overrides the
856 \fBmerge\&.renames\fR
857 configuration variable\&. See also
858 \fBgit-diff\fR(1)
859 \fB\-\-no\-renames\fR\&.
863 resolve
864 .RS 4
865 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\&.
868 octopus
869 .RS 4
870 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\&.
873 ours
874 .RS 4
875 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
876 \fIrecursive\fR
877 merge strategy\&.
880 subtree
881 .RS 4
882 This is a modified
883 \fBort\fR
884 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\&.
887 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\&.
888 .SH "CONFIGURATION"
890 merge\&.conflictStyle
891 .RS 4
892 Specify the style in which conflicted hunks are written out to working tree files upon merge\&. The default is "merge", which shows a
893 \fB<<<<<<<\fR
894 conflict marker, changes made by one side, a
895 \fB=======\fR
896 marker, changes made by the other side, and then a
897 \fB>>>>>>>\fR
898 marker\&. An alternate style, "diff3", adds a
899 \fB|||||||\fR
900 marker and the original text before the
901 \fB=======\fR
902 marker\&.
905 merge\&.defaultToUpstream
906 .RS 4
907 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
908 \fBbranch\&.<current branch>\&.merge\fR
909 that name the branches at the remote named by
910 \fBbranch\&.<current branch>\&.remote\fR
911 are consulted, and then they are mapped via
912 \fBremote\&.<remote>\&.fetch\fR
913 to their corresponding remote\-tracking branches, and the tips of these tracking branches are merged\&. Defaults to true\&.
916 merge\&.ff
917 .RS 4
918 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
919 \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
920 \fB\-\-no\-ff\fR
921 option from the command line)\&. When set to
922 \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
923 \fB\-\-ff\-only\fR
924 option from the command line)\&.
927 merge\&.verifySignatures
928 .RS 4
929 If true, this is equivalent to the \-\-verify\-signatures command line option\&. See
930 \fBgit-merge\fR(1)
931 for details\&.
934 merge\&.branchdesc
935 .RS 4
936 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
939 merge\&.log
940 .RS 4
941 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\&.
944 merge\&.suppressDest
945 .RS 4
946 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\&.
948 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
949 \fBmerge\&.suppressDest\fR
950 variable defined, the default value of
951 \fBmaster\fR
952 is used for backward compatibility\&.
955 merge\&.renameLimit
956 .RS 4
957 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\&.
960 merge\&.renames
961 .RS 4
962 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\&.
965 merge\&.directoryRenames
966 .RS 4
967 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"\&.
970 merge\&.renormalize
971 .RS 4
972 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
973 \fBgitattributes\fR(5)\&.
976 merge\&.stat
977 .RS 4
978 Whether to print the diffstat between ORIG_HEAD and the merge result at the end of the merge\&. True by default\&.
981 merge\&.autoStash
982 .RS 4
983 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
984 \fB\-\-no\-autostash\fR
986 \fB\-\-autostash\fR
987 options of
988 \fBgit-merge\fR(1)\&. Defaults to false\&.
991 merge\&.tool
992 .RS 4
993 Controls which merge tool is used by
994 \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\&.
997 merge\&.guitool
998 .RS 4
999 Controls which merge tool is used by
1000 \fBgit-mergetool\fR(1)
1001 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\&.
1003 .RS 4
1004 .ie n \{\
1005 \h'-04'\(bu\h'+03'\c
1007 .el \{\
1008 .sp -1
1009 .IP \(bu 2.3
1011 araxis
1014 .RS 4
1015 .ie n \{\
1016 \h'-04'\(bu\h'+03'\c
1018 .el \{\
1019 .sp -1
1020 .IP \(bu 2.3
1025 .RS 4
1026 .ie n \{\
1027 \h'-04'\(bu\h'+03'\c
1029 .el \{\
1030 .sp -1
1031 .IP \(bu 2.3
1036 .RS 4
1037 .ie n \{\
1038 \h'-04'\(bu\h'+03'\c
1040 .el \{\
1041 .sp -1
1042 .IP \(bu 2.3
1047 .RS 4
1048 .ie n \{\
1049 \h'-04'\(bu\h'+03'\c
1051 .el \{\
1052 .sp -1
1053 .IP \(bu 2.3
1055 codecompare
1058 .RS 4
1059 .ie n \{\
1060 \h'-04'\(bu\h'+03'\c
1062 .el \{\
1063 .sp -1
1064 .IP \(bu 2.3
1066 deltawalker
1069 .RS 4
1070 .ie n \{\
1071 \h'-04'\(bu\h'+03'\c
1073 .el \{\
1074 .sp -1
1075 .IP \(bu 2.3
1077 diffmerge
1080 .RS 4
1081 .ie n \{\
1082 \h'-04'\(bu\h'+03'\c
1084 .el \{\
1085 .sp -1
1086 .IP \(bu 2.3
1088 diffuse
1091 .RS 4
1092 .ie n \{\
1093 \h'-04'\(bu\h'+03'\c
1095 .el \{\
1096 .sp -1
1097 .IP \(bu 2.3
1099 ecmerge
1102 .RS 4
1103 .ie n \{\
1104 \h'-04'\(bu\h'+03'\c
1106 .el \{\
1107 .sp -1
1108 .IP \(bu 2.3
1110 emerge
1113 .RS 4
1114 .ie n \{\
1115 \h'-04'\(bu\h'+03'\c
1117 .el \{\
1118 .sp -1
1119 .IP \(bu 2.3
1121 examdiff
1124 .RS 4
1125 .ie n \{\
1126 \h'-04'\(bu\h'+03'\c
1128 .el \{\
1129 .sp -1
1130 .IP \(bu 2.3
1132 guiffy
1135 .RS 4
1136 .ie n \{\
1137 \h'-04'\(bu\h'+03'\c
1139 .el \{\
1140 .sp -1
1141 .IP \(bu 2.3
1143 gvimdiff
1146 .RS 4
1147 .ie n \{\
1148 \h'-04'\(bu\h'+03'\c
1150 .el \{\
1151 .sp -1
1152 .IP \(bu 2.3
1154 gvimdiff1
1157 .RS 4
1158 .ie n \{\
1159 \h'-04'\(bu\h'+03'\c
1161 .el \{\
1162 .sp -1
1163 .IP \(bu 2.3
1165 gvimdiff2
1168 .RS 4
1169 .ie n \{\
1170 \h'-04'\(bu\h'+03'\c
1172 .el \{\
1173 .sp -1
1174 .IP \(bu 2.3
1176 gvimdiff3
1179 .RS 4
1180 .ie n \{\
1181 \h'-04'\(bu\h'+03'\c
1183 .el \{\
1184 .sp -1
1185 .IP \(bu 2.3
1187 kdiff3
1190 .RS 4
1191 .ie n \{\
1192 \h'-04'\(bu\h'+03'\c
1194 .el \{\
1195 .sp -1
1196 .IP \(bu 2.3
1198 meld
1201 .RS 4
1202 .ie n \{\
1203 \h'-04'\(bu\h'+03'\c
1205 .el \{\
1206 .sp -1
1207 .IP \(bu 2.3
1209 nvimdiff
1212 .RS 4
1213 .ie n \{\
1214 \h'-04'\(bu\h'+03'\c
1216 .el \{\
1217 .sp -1
1218 .IP \(bu 2.3
1220 nvimdiff1
1223 .RS 4
1224 .ie n \{\
1225 \h'-04'\(bu\h'+03'\c
1227 .el \{\
1228 .sp -1
1229 .IP \(bu 2.3
1231 nvimdiff2
1234 .RS 4
1235 .ie n \{\
1236 \h'-04'\(bu\h'+03'\c
1238 .el \{\
1239 .sp -1
1240 .IP \(bu 2.3
1242 nvimdiff3
1245 .RS 4
1246 .ie n \{\
1247 \h'-04'\(bu\h'+03'\c
1249 .el \{\
1250 .sp -1
1251 .IP \(bu 2.3
1253 opendiff
1256 .RS 4
1257 .ie n \{\
1258 \h'-04'\(bu\h'+03'\c
1260 .el \{\
1261 .sp -1
1262 .IP \(bu 2.3
1264 p4merge
1267 .RS 4
1268 .ie n \{\
1269 \h'-04'\(bu\h'+03'\c
1271 .el \{\
1272 .sp -1
1273 .IP \(bu 2.3
1275 smerge
1278 .RS 4
1279 .ie n \{\
1280 \h'-04'\(bu\h'+03'\c
1282 .el \{\
1283 .sp -1
1284 .IP \(bu 2.3
1286 tkdiff
1289 .RS 4
1290 .ie n \{\
1291 \h'-04'\(bu\h'+03'\c
1293 .el \{\
1294 .sp -1
1295 .IP \(bu 2.3
1297 tortoisemerge
1300 .RS 4
1301 .ie n \{\
1302 \h'-04'\(bu\h'+03'\c
1304 .el \{\
1305 .sp -1
1306 .IP \(bu 2.3
1308 vimdiff
1311 .RS 4
1312 .ie n \{\
1313 \h'-04'\(bu\h'+03'\c
1315 .el \{\
1316 .sp -1
1317 .IP \(bu 2.3
1319 vimdiff1
1322 .RS 4
1323 .ie n \{\
1324 \h'-04'\(bu\h'+03'\c
1326 .el \{\
1327 .sp -1
1328 .IP \(bu 2.3
1330 vimdiff2
1333 .RS 4
1334 .ie n \{\
1335 \h'-04'\(bu\h'+03'\c
1337 .el \{\
1338 .sp -1
1339 .IP \(bu 2.3
1341 vimdiff3
1344 .RS 4
1345 .ie n \{\
1346 \h'-04'\(bu\h'+03'\c
1348 .el \{\
1349 .sp -1
1350 .IP \(bu 2.3
1352 winmerge
1355 .RS 4
1356 .ie n \{\
1357 \h'-04'\(bu\h'+03'\c
1359 .el \{\
1360 .sp -1
1361 .IP \(bu 2.3
1363 xxdiff
1367 merge\&.verbosity
1368 .RS 4
1369 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
1370 \fBGIT_MERGE_VERBOSITY\fR
1371 environment variable\&.
1374 merge\&.<driver>\&.name
1375 .RS 4
1376 Defines a human\-readable name for a custom low\-level merge driver\&. See
1377 \fBgitattributes\fR(5)
1378 for details\&.
1381 merge\&.<driver>\&.driver
1382 .RS 4
1383 Defines the command that implements a custom low\-level merge driver\&. See
1384 \fBgitattributes\fR(5)
1385 for details\&.
1388 merge\&.<driver>\&.recursive
1389 .RS 4
1390 Names a low\-level merge driver to be used when performing an internal merge between common ancestors\&. See
1391 \fBgitattributes\fR(5)
1392 for details\&.
1395 branch\&.<name>\&.mergeOptions
1396 .RS 4
1397 Sets default options for merging into branch <name>\&. The syntax and supported options are the same as those of
1398 \fIgit merge\fR, but option values containing whitespace characters are currently not supported\&.
1400 .SH "SEE ALSO"
1402 \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)
1403 .SH "GIT"
1405 Part of the \fBgit\fR(1) suite