Autogenerated manpages for v2.47.0-rc0
[git-manpages.git] / man1 / git-merge.1
blob9c74705fdf659ac6f688491e5f55b93b2b1cd293
1 '\" t
2 .\"     Title: git-merge
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\"      Date: 2024-09-25
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.47.0.rc0
8 .\"  Language: English
9 .\"
10 .TH "GIT\-MERGE" "1" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "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 .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 \fBgit 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 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)\&.
61 .sp
62 .if n \{\
63 .RS 4
64 .\}
65 .nf
66           A\-\-\-B\-\-\-C topic
67          /         \e
68     D\-\-\-E\-\-\-F\-\-\-G\-\-\-H master
69 .fi
70 .if n \{\
71 .RE
72 .\}
73 .sp
74 A merge stops if there\(cqs a conflict that cannot be resolved automatically or if \fB\-\-no\-commit\fR was provided when initiating the merge\&. At that point you can run \fBgit merge \-\-abort\fR or \fBgit merge \-\-continue\fR\&.
75 .sp
76 \fBgit 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), \fBgit merge \-\-abort\fR will in some cases be unable to reconstruct the original (pre\-merge) changes\&. Therefore:
77 .sp
78 \fBWarning\fR: Running \fBgit 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 .SH "OPTIONS"
80 .PP
81 \-\-commit, \-\-no\-commit
82 .RS 4
83 Perform the merge and commit the result\&. This option can be used to override \-\-no\-commit\&.
84 .sp
85 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\&.
86 .sp
87 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\&.
88 .RE
89 .PP
90 \-\-edit, \-e, \-\-no\-edit
91 .RS 4
92 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
93 \fB\-\-no\-edit\fR
94 option can be used to accept the auto\-generated message (this is generally discouraged)\&. The
95 \fB\-\-edit\fR
96 (or
97 \fB\-e\fR) option is still useful if you are giving a draft message with the
98 \fB\-m\fR
99 option from the command line and want to edit it in the editor\&.
101 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
102 \fBgit merge\fR\&. To make it easier to adjust such scripts to the updated behaviour, the environment variable
103 \fBGIT_MERGE_AUTOEDIT\fR
104 can be set to
105 \fBno\fR
106 at the beginning of them\&.
109 \-\-cleanup=<mode>
110 .RS 4
111 This option determines how the merge message will be cleaned up before committing\&. See
112 \fBgit-commit\fR(1)
113 for more details\&. In addition, if the
114 \fI<mode>\fR
115 is given a value of
116 \fBscissors\fR, scissors will be appended to
117 \fBMERGE_MSG\fR
118 before being passed on to the commit machinery in the case of a merge conflict\&.
121 \-\-ff, \-\-no\-ff, \-\-ff\-only
122 .RS 4
123 Specifies how a merge is handled when the merged\-in history is already a descendant of the current history\&.
124 \fB\-\-ff\fR
125 is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the
126 \fBrefs/tags/\fR
127 hierarchy, in which case
128 \fB\-\-no\-ff\fR
129 is assumed\&.
131 With
132 \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\&.
134 With
135 \fB\-\-no\-ff\fR, create a merge commit in all cases, even when the merge could instead be resolved as a fast\-forward\&.
137 With
138 \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\&.
141 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
142 .RS 4
143 GPG\-sign the resulting merge commit\&. The
144 \fBkeyid\fR
145 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
146 \fB\-\-no\-gpg\-sign\fR
147 is useful to countermand both
148 \fBcommit\&.gpgSign\fR
149 configuration variable, and earlier
150 \fB\-\-gpg\-sign\fR\&.
153 \-\-log[=<n>], \-\-no\-log
154 .RS 4
155 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
156 \fBgit-fmt-merge-msg\fR(1)\&.
158 With \-\-no\-log do not list one\-line descriptions from the actual commits being merged\&.
161 \-\-signoff, \-\-no\-signoff
162 .RS 4
163 Add a
164 \fBSigned\-off\-by\fR
165 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
166 \m[blue]\fBhttps://developercertificate\&.org\fR\m[]
167 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\&.
169 The \-\-no\-signoff option can be used to countermand an earlier \-\-signoff option on the command line\&.
172 \-\-stat, \-n, \-\-no\-stat
173 .RS 4
174 Show a diffstat at the end of the merge\&. The diffstat is also controlled by the configuration option merge\&.stat\&.
176 With \-n or \-\-no\-stat do not show a diffstat at the end of the merge\&.
179 \-\-squash, \-\-no\-squash
180 .RS 4
181 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
182 \fBHEAD\fR, or record
183 \fB$GIT_DIR/MERGE_HEAD\fR
184 (to cause the next
185 \fBgit commit\fR
186 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)\&.
188 With \-\-no\-squash perform the merge and commit the result\&. This option can be used to override \-\-squash\&.
190 With \-\-squash, \-\-commit is not allowed, and will fail\&.
193 \-\-[no\-]verify
194 .RS 4
195 By default, the pre\-merge and commit\-msg hooks are run\&. When
196 \fB\-\-no\-verify\fR
197 is given, these are bypassed\&. See also
198 \fBgithooks\fR(5)\&.
201 \-s <strategy>, \-\-strategy=<strategy>
202 .RS 4
203 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
204 \fB\-s\fR
205 option, a built\-in list of strategies is used instead (\fBort\fR
206 when merging a single head,
207 \fBoctopus\fR
208 otherwise)\&.
211 \-X <option>, \-\-strategy\-option=<option>
212 .RS 4
213 Pass merge strategy specific option through to the merge strategy\&.
216 \-\-verify\-signatures, \-\-no\-verify\-signatures
217 .RS 4
218 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\&.
221 \-\-summary, \-\-no\-summary
222 .RS 4
223 Synonyms to \-\-stat and \-\-no\-stat; these are deprecated and will be removed in the future\&.
226 \-q, \-\-quiet
227 .RS 4
228 Operate quietly\&. Implies \-\-no\-progress\&.
231 \-v, \-\-verbose
232 .RS 4
233 Be verbose\&.
236 \-\-progress, \-\-no\-progress
237 .RS 4
238 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\&.
241 \-\-autostash, \-\-no\-autostash
242 .RS 4
243 Automatically create a temporary stash entry before the operation begins, record it in the ref
244 \fBMERGE_AUTOSTASH\fR
245 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\&.
248 \-\-allow\-unrelated\-histories
249 .RS 4
250 By default,
251 \fBgit merge\fR
252 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\&.
255 \-m <msg>
256 .RS 4
257 Set the commit message to be used for the merge commit (in case one is created)\&.
260 \fB\-\-log\fR
261 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
264 \fBgit fmt\-merge\-msg\fR
265 command can be used to give a good default for automated
266 \fBgit merge\fR
267 invocations\&. The automated message can include the branch description\&.
270 \-\-into\-name <branch>
271 .RS 4
272 Prepare the default merge message as if merging to the branch
273 \fB<branch>\fR, instead of the name of the real branch to which the merge is made\&.
276 \-F <file>, \-\-file=<file>
277 .RS 4
278 Read the commit message to be used for the merge commit (in case one is created)\&.
281 \fB\-\-log\fR
282 is specified, a shortlog of the commits being merged will be appended to the specified message\&.
285 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
286 .RS 4
287 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\&.
288 \fB\-\-no\-rerere\-autoupdate\fR
289 is a good way to double\-check what
290 \fBrerere\fR
291 did and catch potential mismerges, before committing the result to the index with a separate
292 \fBgit add\fR\&.
295 \-\-overwrite\-ignore, \-\-no\-overwrite\-ignore
296 .RS 4
297 Silently overwrite ignored files from the merge result\&. This is the default behavior\&. Use
298 \fB\-\-no\-overwrite\-ignore\fR
299 to abort\&.
302 \-\-abort
303 .RS 4
304 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\&.
306 If there were uncommitted worktree changes present when the merge started,
307 \fBgit merge \-\-abort\fR
308 will in some cases be unable to reconstruct these changes\&. It is therefore recommended to always commit or stash your changes before running
309 \fBgit merge\fR\&.
311 \fBgit merge \-\-abort\fR
312 is equivalent to
313 \fBgit reset \-\-merge\fR
314 when
315 \fBMERGE_HEAD\fR
316 is present unless
317 \fBMERGE_AUTOSTASH\fR
318 is also present in which case
319 \fBgit merge \-\-abort\fR
320 applies the stash entry to the worktree whereas
321 \fBgit reset \-\-merge\fR
322 will save the stashed changes in the stash list\&.
325 \-\-quit
326 .RS 4
327 Forget about the current merge in progress\&. Leave the index and the working tree as\-is\&. If
328 \fBMERGE_AUTOSTASH\fR
329 is present, the stash entry will be saved to the stash list\&.
332 \-\-continue
333 .RS 4
334 After a
335 \fBgit merge\fR
336 stops due to conflicts you can conclude the merge by running
337 \fBgit merge \-\-continue\fR
338 (see "HOW TO RESOLVE CONFLICTS" section below)\&.
341 <commit>\&...\:
342 .RS 4
343 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)\&.
345 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\&.
347 When
348 \fBFETCH_HEAD\fR
349 (and no other commit) is specified, the branches recorded in the
350 \fB\&.git/FETCH_HEAD\fR
351 file by the previous invocation of
352 \fBgit fetch\fR
353 for merging are merged to the current branch\&.
355 .SH "PRE\-MERGE CHECKS"
357 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)\&. \fBgit pull\fR and \fBgit merge\fR will stop without doing anything when local uncommitted changes overlap with files that \fBgit pull\fR/\fBgit merge\fR may need to update\&.
359 To avoid recording unrelated changes in the merge commit, \fBgit pull\fR and \fBgit 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\&.)
361 If all named commits are already ancestors of \fBHEAD\fR, \fBgit merge\fR will exit early with the message "Already up to date\&."
362 .SH "FAST\-FORWARD MERGE"
364 Often the current branch head is an ancestor of the named commit\&. This is the most common case especially when invoked from \fBgit 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\&.
366 This behavior can be suppressed with the \fB\-\-no\-ff\fR option\&.
367 .SH "TRUE MERGE"
369 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\&.
371 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\&.
373 When it is not obvious how to reconcile the changes, the following happens:
375 .RS 4
376 .ie n \{\
377 \h'-04' 1.\h'+01'\c
379 .el \{\
380 .sp -1
381 .IP "  1." 4.2
384 \fBHEAD\fR
385 pointer stays the same\&.
388 .RS 4
389 .ie n \{\
390 \h'-04' 2.\h'+01'\c
392 .el \{\
393 .sp -1
394 .IP "  2." 4.2
397 \fBMERGE_HEAD\fR
398 ref is set to point to the other branch head\&.
401 .RS 4
402 .ie n \{\
403 \h'-04' 3.\h'+01'\c
405 .el \{\
406 .sp -1
407 .IP "  3." 4.2
409 Paths that merged cleanly are updated both in the index file and in your working tree\&.
412 .RS 4
413 .ie n \{\
414 \h'-04' 4.\h'+01'\c
416 .el \{\
417 .sp -1
418 .IP "  4." 4.2
420 For conflicting paths, the index file records up to three versions: stage 1 stores the version from the common ancestor, stage 2 from
421 \fBHEAD\fR, and stage 3 from
422 \fBMERGE_HEAD\fR
423 (you can inspect the stages with
424 \fBgit ls\-files \-u\fR)\&. The working tree files contain the result of the merge operation; i\&.e\&. 3\-way merge results with familiar conflict markers
425 \fB<<<\fR
426 \fB===\fR
427 \fB>>>\fR\&.
430 .RS 4
431 .ie n \{\
432 \h'-04' 5.\h'+01'\c
434 .el \{\
435 .sp -1
436 .IP "  5." 4.2
438 A ref named
439 \fBAUTO_MERGE\fR
440 is written, pointing to a tree corresponding to the current content of the working tree (including conflict markers for textual conflicts)\&. Note that this ref is only written when the
441 \fIort\fR
442 merge strategy is used (the default)\&.
445 .RS 4
446 .ie n \{\
447 \h'-04' 6.\h'+01'\c
449 .el \{\
450 .sp -1
451 .IP "  6." 4.2
453 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
454 \fBHEAD\fR\&.
457 If you tried a merge which resulted in complex conflicts and want to start over, you can recover with \fBgit merge \-\-abort\fR\&.
458 .SH "MERGING TAG"
460 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)\&.
462 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\&.
464 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\&.
466 .if n \{\
467 .RS 4
470 git fetch origin
471 git merge v1\&.2\&.3^0
472 git merge \-\-ff\-only v1\&.2\&.3
474 .if n \{\
477 .SH "HOW CONFLICTS ARE PRESENTED"
479 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\&.
481 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:
483 .if n \{\
484 .RS 4
487 Here are lines that are either unchanged from the common
488 ancestor, or cleanly resolved because only one side changed,
489 or cleanly resolved because both sides changed the same way\&.
490 <<<<<<< yours:sample\&.txt
491 Conflict resolution is hard;
492 let\*(Aqs go shopping\&.
493 =======
494 Git makes conflict resolution easy\&.
495 >>>>>>> theirs:sample\&.txt
496 And here is another line that is cleanly resolved or unmodified\&.
498 .if n \{\
502 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\&.
504 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\&.
506 An alternative style can be used by setting the \fBmerge\&.conflictStyle\fR configuration variable to either "diff3" or "zdiff3"\&. In "diff3" style, the above conflict may look like this:
508 .if n \{\
509 .RS 4
512 Here are lines that are either unchanged from the common
513 ancestor, or cleanly resolved because only one side changed,
514 <<<<<<< yours:sample\&.txt
515 or cleanly resolved because both sides changed the same way\&.
516 Conflict resolution is hard;
517 let\*(Aqs go shopping\&.
518 ||||||| base:sample\&.txt
519 or cleanly resolved because both sides changed identically\&.
520 Conflict resolution is hard\&.
521 =======
522 or cleanly resolved because both sides changed the same way\&.
523 Git makes conflict resolution easy\&.
524 >>>>>>> theirs:sample\&.txt
525 And here is another line that is cleanly resolved or unmodified\&.
527 .if n \{\
531 while in "zdiff3" style, it may look like this:
533 .if n \{\
534 .RS 4
537 Here are lines that are either unchanged from the common
538 ancestor, or cleanly resolved because only one side changed,
539 or cleanly resolved because both sides changed the same way\&.
540 <<<<<<< yours:sample\&.txt
541 Conflict resolution is hard;
542 let\*(Aqs go shopping\&.
543 ||||||| base:sample\&.txt
544 or cleanly resolved because both sides changed identically\&.
545 Conflict resolution is hard\&.
546 =======
547 Git makes conflict resolution easy\&.
548 >>>>>>> theirs:sample\&.txt
549 And here is another line that is cleanly resolved or unmodified\&.
551 .if n \{\
555 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\&.
556 .SH "HOW TO RESOLVE CONFLICTS"
558 After seeing a conflict, you can do two things:
560 .RS 4
561 .ie n \{\
562 \h'-04'\(bu\h'+03'\c
564 .el \{\
565 .sp -1
566 .IP \(bu 2.3
568 Decide not to merge\&. The only clean\-ups you need are to reset the index file to the
569 \fBHEAD\fR
570 commit to reverse 2\&. and to clean up working tree changes made by 2\&. and 3\&.;
571 \fBgit merge \-\-abort\fR
572 can be used for this\&.
575 .RS 4
576 .ie n \{\
577 \h'-04'\(bu\h'+03'\c
579 .el \{\
580 .sp -1
581 .IP \(bu 2.3
583 Resolve the conflicts\&. Git will mark the conflicts in the working tree\&. Edit the files into shape and
584 \fBgit add\fR
585 them to the index\&. Use
586 \fBgit commit\fR
588 \fBgit merge \-\-continue\fR
589 to seal the deal\&. The latter command checks whether there is a (interrupted) merge in progress before calling
590 \fBgit commit\fR\&.
593 You can work through the conflict with a number of tools:
595 .RS 4
596 .ie n \{\
597 \h'-04'\(bu\h'+03'\c
599 .el \{\
600 .sp -1
601 .IP \(bu 2.3
603 Use a mergetool\&.
604 \fBgit mergetool\fR
605 to launch a graphical mergetool which will work through the merge with you\&.
608 .RS 4
609 .ie n \{\
610 \h'-04'\(bu\h'+03'\c
612 .el \{\
613 .sp -1
614 .IP \(bu 2.3
616 Look at the diffs\&.
617 \fBgit diff\fR
618 will show a three\-way diff, highlighting changes from both the
619 \fBHEAD\fR
621 \fBMERGE_HEAD\fR
622 versions\&.
623 \fBgit diff AUTO_MERGE\fR
624 will show what changes you\(cqve made so far to resolve textual conflicts\&.
627 .RS 4
628 .ie n \{\
629 \h'-04'\(bu\h'+03'\c
631 .el \{\
632 .sp -1
633 .IP \(bu 2.3
635 Look at the diffs from each branch\&.
636 \fBgit log \-\-merge \-p <path>\fR
637 will show diffs first for the
638 \fBHEAD\fR
639 version and then the
640 \fBMERGE_HEAD\fR
641 version\&.
644 .RS 4
645 .ie n \{\
646 \h'-04'\(bu\h'+03'\c
648 .el \{\
649 .sp -1
650 .IP \(bu 2.3
652 Look at the originals\&.
653 \fBgit show :1:filename\fR
654 shows the common ancestor,
655 \fBgit show :2:filename\fR
656 shows the
657 \fBHEAD\fR
658 version, and
659 \fBgit show :3:filename\fR
660 shows the
661 \fBMERGE_HEAD\fR
662 version\&.
664 .SH "EXAMPLES"
666 .RS 4
667 .ie n \{\
668 \h'-04'\(bu\h'+03'\c
670 .el \{\
671 .sp -1
672 .IP \(bu 2.3
674 Merge branches
675 \fBfixes\fR
677 \fBenhancements\fR
678 on top of the current branch, making an octopus merge:
680 .if n \{\
681 .RS 4
684 $ git merge fixes enhancements
686 .if n \{\
691 .RS 4
692 .ie n \{\
693 \h'-04'\(bu\h'+03'\c
695 .el \{\
696 .sp -1
697 .IP \(bu 2.3
699 Merge branch
700 \fBobsolete\fR
701 into the current branch, using
702 \fBours\fR
703 merge strategy:
705 .if n \{\
706 .RS 4
709 $ git merge \-s ours obsolete
711 .if n \{\
716 .RS 4
717 .ie n \{\
718 \h'-04'\(bu\h'+03'\c
720 .el \{\
721 .sp -1
722 .IP \(bu 2.3
724 Merge branch
725 \fBmaint\fR
726 into the current branch, but do not make a new commit automatically:
728 .if n \{\
729 .RS 4
732 $ git merge \-\-no\-commit maint
734 .if n \{\
738 This can be used when you want to include further changes to the merge, or want to write your own merge commit message\&.
740 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\&.
742 .SH "MERGE STRATEGIES"
744 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\&.
747 .RS 4
748 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,
749 \fBrecursive\fR\&.
752 \fIort\fR
753 strategy can take the following options:
755 ours
756 .RS 4
757 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
758 \fIour\fR
759 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\&.
761 This should not be confused with the
762 \fIours\fR
763 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
764 \fIour\fR
765 history contains all that happened in it\&.
768 theirs
769 .RS 4
770 This is the opposite of
771 \fIours\fR; note that, unlike
772 \fIours\fR, there is no
773 \fItheirs\fR
774 merge strategy to confuse this merge option with\&.
777 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
778 .RS 4
779 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
780 \fBgit-diff\fR(1)
781 \fB\-b\fR,
782 \fB\-w\fR,
783 \fB\-\-ignore\-space\-at\-eol\fR, and
784 \fB\-\-ignore\-cr\-at\-eol\fR\&.
786 .RS 4
787 .ie n \{\
788 \h'-04'\(bu\h'+03'\c
790 .el \{\
791 .sp -1
792 .IP \(bu 2.3
795 \fItheir\fR
796 version only introduces whitespace changes to a line,
797 \fIour\fR
798 version is used;
801 .RS 4
802 .ie n \{\
803 \h'-04'\(bu\h'+03'\c
805 .el \{\
806 .sp -1
807 .IP \(bu 2.3
810 \fIour\fR
811 version introduces whitespace changes but
812 \fItheir\fR
813 version includes a substantial change,
814 \fItheir\fR
815 version is used;
818 .RS 4
819 .ie n \{\
820 \h'-04'\(bu\h'+03'\c
822 .el \{\
823 .sp -1
824 .IP \(bu 2.3
826 Otherwise, the merge proceeds in the usual way\&.
830 renormalize
831 .RS 4
832 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
833 \fBgitattributes\fR(5)
834 for details\&.
837 no\-renormalize
838 .RS 4
839 Disables the
840 \fBrenormalize\fR
841 option\&. This overrides the
842 \fBmerge\&.renormalize\fR
843 configuration variable\&.
846 find\-renames[=<n>]
847 .RS 4
848 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
849 \fImerge\&.renames\fR
850 configuration variable\&. See also
851 \fBgit-diff\fR(1)
852 \fB\-\-find\-renames\fR\&.
855 rename\-threshold=<n>
856 .RS 4
857 Deprecated synonym for
858 \fBfind\-renames=<n>\fR\&.
861 subtree[=<path>]
862 .RS 4
863 This option is a more advanced form of
864 \fIsubtree\fR
865 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\&.
869 recursive
870 .RS 4
871 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\&.
874 \fIrecursive\fR
875 strategy takes the same options as
876 \fIort\fR\&. However, there are three additional options that
877 \fIort\fR
878 ignores (not documented above) that are potentially useful with the
879 \fIrecursive\fR
880 strategy:
882 patience
883 .RS 4
884 Deprecated synonym for
885 \fBdiff\-algorithm=patience\fR\&.
888 diff\-algorithm=[patience|minimal|histogram|myers]
889 .RS 4
890 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
891 \fBgit-diff\fR(1)
892 \fB\-\-diff\-algorithm\fR\&. Note that
893 \fBort\fR
894 specifically uses
895 \fBdiff\-algorithm=histogram\fR, while
896 \fBrecursive\fR
897 defaults to the
898 \fBdiff\&.algorithm\fR
899 config setting\&.
902 no\-renames
903 .RS 4
904 Turn off rename detection\&. This overrides the
905 \fBmerge\&.renames\fR
906 configuration variable\&. See also
907 \fBgit-diff\fR(1)
908 \fB\-\-no\-renames\fR\&.
912 resolve
913 .RS 4
914 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\&.
917 octopus
918 .RS 4
919 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\&.
922 ours
923 .RS 4
924 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
925 \fIrecursive\fR
926 merge strategy\&.
929 subtree
930 .RS 4
931 This is a modified
932 \fBort\fR
933 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\&.
936 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\&.
937 .SH "CONFIGURATION"
939 branch\&.<name>\&.mergeOptions
940 .RS 4
941 Sets default options for merging into branch <name>\&. The syntax and supported options are the same as those of
942 \fBgit merge\fR, but option values containing whitespace characters are currently not supported\&.
945 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:
947 merge\&.conflictStyle
948 .RS 4
949 Specify the style in which conflicted hunks are written out to working tree files upon merge\&. The default is "merge", which shows a
950 \fB<<<<<<<\fR
951 conflict marker, changes made by one side, a
952 \fB=======\fR
953 marker, changes made by the other side, and then a
954 \fB>>>>>>>\fR
955 marker\&. An alternate style, "diff3", adds a
956 \fB|||||||\fR
957 marker and the original text before the
958 \fB=======\fR
959 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\&.
962 merge\&.defaultToUpstream
963 .RS 4
964 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
965 \fBbranch\&.<current branch>\&.merge\fR
966 that name the branches at the remote named by
967 \fBbranch\&.<current branch>\&.remote\fR
968 are consulted, and then they are mapped via
969 \fBremote\&.<remote>\&.fetch\fR
970 to their corresponding remote\-tracking branches, and the tips of these tracking branches are merged\&. Defaults to true\&.
973 merge\&.ff
974 .RS 4
975 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
976 \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
977 \fB\-\-no\-ff\fR
978 option from the command line)\&. When set to
979 \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
980 \fB\-\-ff\-only\fR
981 option from the command line)\&.
984 merge\&.verifySignatures
985 .RS 4
986 If true, this is equivalent to the \-\-verify\-signatures command line option\&. See
987 \fBgit-merge\fR(1)
988 for details\&.
991 merge\&.branchdesc
992 .RS 4
993 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
996 merge\&.log
997 .RS 4
998 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\&.
1001 merge\&.suppressDest
1002 .RS 4
1003 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\&.
1005 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
1006 \fBmerge\&.suppressDest\fR
1007 variable defined, the default value of
1008 \fBmaster\fR
1009 is used for backward compatibility\&.
1012 merge\&.renameLimit
1013 .RS 4
1014 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\&.
1017 merge\&.renames
1018 .RS 4
1019 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\&.
1022 merge\&.directoryRenames
1023 .RS 4
1024 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"\&.
1027 merge\&.renormalize
1028 .RS 4
1029 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
1030 \fBgitattributes\fR(5)\&.
1033 merge\&.stat
1034 .RS 4
1035 Whether to print the diffstat between ORIG_HEAD and the merge result at the end of the merge\&. True by default\&.
1038 merge\&.autoStash
1039 .RS 4
1040 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
1041 \fB\-\-no\-autostash\fR
1043 \fB\-\-autostash\fR
1044 options of
1045 \fBgit-merge\fR(1)\&. Defaults to false\&.
1048 merge\&.tool
1049 .RS 4
1050 Controls which merge tool is used by
1051 \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\&.
1054 merge\&.guitool
1055 .RS 4
1056 Controls which merge tool is used by
1057 \fBgit-mergetool\fR(1)
1058 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\&.
1060 \fBaraxis\fR
1061 .RS 4
1062 Use Araxis Merge (requires a graphical session)
1065 \fBbc\fR
1066 .RS 4
1067 Use Beyond Compare (requires a graphical session)
1070 \fBbc3\fR
1071 .RS 4
1072 Use Beyond Compare (requires a graphical session)
1075 \fBbc4\fR
1076 .RS 4
1077 Use Beyond Compare (requires a graphical session)
1080 \fBcodecompare\fR
1081 .RS 4
1082 Use Code Compare (requires a graphical session)
1085 \fBdeltawalker\fR
1086 .RS 4
1087 Use DeltaWalker (requires a graphical session)
1090 \fBdiffmerge\fR
1091 .RS 4
1092 Use DiffMerge (requires a graphical session)
1095 \fBdiffuse\fR
1096 .RS 4
1097 Use Diffuse (requires a graphical session)
1100 \fBecmerge\fR
1101 .RS 4
1102 Use ECMerge (requires a graphical session)
1105 \fBemerge\fR
1106 .RS 4
1107 Use Emacs\*(Aq Emerge
1110 \fBexamdiff\fR
1111 .RS 4
1112 Use ExamDiff Pro (requires a graphical session)
1115 \fBguiffy\fR
1116 .RS 4
1117 Use Guiffy\(cqs Diff Tool (requires a graphical session)
1120 \fBgvimdiff\fR
1121 .RS 4
1122 Use gVim (requires a graphical session) with a custom layout (see
1123 \fBgit help mergetool\fR\*(Aqs
1124 \fBBACKEND SPECIFIC HINTS\fR
1125 section)
1128 \fBgvimdiff1\fR
1129 .RS 4
1130 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
1133 \fBgvimdiff2\fR
1134 .RS 4
1135 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
1138 \fBgvimdiff3\fR
1139 .RS 4
1140 Use gVim (requires a graphical session) where only the MERGED file is shown
1143 \fBkdiff3\fR
1144 .RS 4
1145 Use KDiff3 (requires a graphical session)
1148 \fBmeld\fR
1149 .RS 4
1150 Use Meld (requires a graphical session) with optional
1151 \fBauto merge\fR
1152 (see
1153 \fBgit help mergetool\fR\*(Aqs
1154 \fBCONFIGURATION\fR
1155 section)
1158 \fBnvimdiff\fR
1159 .RS 4
1160 Use Neovim with a custom layout (see
1161 \fBgit help mergetool\fR\*(Aqs
1162 \fBBACKEND SPECIFIC HINTS\fR
1163 section)
1166 \fBnvimdiff1\fR
1167 .RS 4
1168 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
1171 \fBnvimdiff2\fR
1172 .RS 4
1173 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
1176 \fBnvimdiff3\fR
1177 .RS 4
1178 Use Neovim where only the MERGED file is shown
1181 \fBopendiff\fR
1182 .RS 4
1183 Use FileMerge (requires a graphical session)
1186 \fBp4merge\fR
1187 .RS 4
1188 Use HelixCore P4Merge (requires a graphical session)
1191 \fBsmerge\fR
1192 .RS 4
1193 Use Sublime Merge (requires a graphical session)
1196 \fBtkdiff\fR
1197 .RS 4
1198 Use TkDiff (requires a graphical session)
1201 \fBtortoisemerge\fR
1202 .RS 4
1203 Use TortoiseMerge (requires a graphical session)
1206 \fBvimdiff\fR
1207 .RS 4
1208 Use Vim with a custom layout (see
1209 \fBgit help mergetool\fR\*(Aqs
1210 \fBBACKEND SPECIFIC HINTS\fR
1211 section)
1214 \fBvimdiff1\fR
1215 .RS 4
1216 Use Vim with a 2 panes layout (LOCAL and REMOTE)
1219 \fBvimdiff2\fR
1220 .RS 4
1221 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
1224 \fBvimdiff3\fR
1225 .RS 4
1226 Use Vim where only the MERGED file is shown
1229 \fBvscode\fR
1230 .RS 4
1231 Use Visual Studio Code (requires a graphical session)
1234 \fBwinmerge\fR
1235 .RS 4
1236 Use WinMerge (requires a graphical session)
1239 \fBxxdiff\fR
1240 .RS 4
1241 Use xxdiff (requires a graphical session)
1245 merge\&.verbosity
1246 .RS 4
1247 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
1248 \fBGIT_MERGE_VERBOSITY\fR
1249 environment variable\&.
1252 merge\&.<driver>\&.name
1253 .RS 4
1254 Defines a human\-readable name for a custom low\-level merge driver\&. See
1255 \fBgitattributes\fR(5)
1256 for details\&.
1259 merge\&.<driver>\&.driver
1260 .RS 4
1261 Defines the command that implements a custom low\-level merge driver\&. See
1262 \fBgitattributes\fR(5)
1263 for details\&.
1266 merge\&.<driver>\&.recursive
1267 .RS 4
1268 Names a low\-level merge driver to be used when performing an internal merge between common ancestors\&. See
1269 \fBgitattributes\fR(5)
1270 for details\&.
1272 .SH "SEE ALSO"
1274 \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)
1275 .SH "GIT"
1277 Part of the \fBgit\fR(1) suite