Autogenerated HTML docs for v2.45.0-31-gd4cc1
[git-htmldocs.git] / git-merge.txt
blob1ab69f61f5749a21def2b08d7cd9466f59c3cd5c
1 git-merge(1)
2 ============
4 NAME
5 ----
6 git-merge - Join two or more development histories together
9 SYNOPSIS
10 --------
11 [verse]
12 'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
13         [--no-verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
14         [--[no-]allow-unrelated-histories]
15         [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>]
16         [--into-name <branch>] [<commit>...]
17 'git merge' (--continue | --abort | --quit)
19 DESCRIPTION
20 -----------
21 Incorporates changes from the named commits (since the time their
22 histories diverged from the current branch) into the current
23 branch.  This command is used by `git pull` to incorporate changes
24 from another repository and can be used by hand to merge changes
25 from one branch into another.
27 Assume the following history exists and the current branch is
28 `master`:
30 ------------
31           A---B---C topic
32          /
33     D---E---F---G master
34 ------------
36 Then `git merge topic` will replay the changes made on the
37 `topic` branch since it diverged from `master` (i.e., `E`) until
38 its current commit (`C`) on top of `master`, and record the result
39 in a new commit along with the names of the two parent commits and
40 a log message from the user describing the changes. Before the operation,
41 `ORIG_HEAD` is set to the tip of the current branch (`C`).
43 ------------
44           A---B---C topic
45          /         \
46     D---E---F---G---H master
47 ------------
49 A merge stops if there's a conflict that cannot be resolved
50 automatically or if `--no-commit` was provided when initiating the
51 merge. At that point you can run `git merge --abort` or `git merge
52 --continue`.
54 `git merge --abort` will abort the merge process and try to reconstruct
55 the pre-merge state. However, if there were uncommitted changes when the
56 merge started (and especially if those changes were further modified
57 after the merge was started), `git merge --abort` will in some cases be
58 unable to reconstruct the original (pre-merge) changes. Therefore:
60 *Warning*: Running `git merge` with non-trivial uncommitted changes is
61 discouraged: while possible, it may leave you in a state that is hard to
62 back out of in the case of a conflict.
64 OPTIONS
65 -------
66 :git-merge: 1
68 include::merge-options.txt[]
70 -m <msg>::
71         Set the commit message to be used for the merge commit (in
72         case one is created).
74 If `--log` is specified, a shortlog of the commits being merged
75 will be appended to the specified message.
77 The `git fmt-merge-msg` command can be
78 used to give a good default for automated `git merge`
79 invocations. The automated message can include the branch description.
81 --into-name <branch>::
82         Prepare the default merge message as if merging to the branch
83         `<branch>`, instead of the name of the real branch to which
84         the merge is made.
86 -F <file>::
87 --file=<file>::
88         Read the commit message to be used for the merge commit (in
89         case one is created).
91 If `--log` is specified, a shortlog of the commits being merged
92 will be appended to the specified message.
94 include::rerere-options.txt[]
96 --overwrite-ignore::
97 --no-overwrite-ignore::
98         Silently overwrite ignored files from the merge result. This
99         is the default behavior. Use `--no-overwrite-ignore` to abort.
101 --abort::
102         Abort the current conflict resolution process, and
103         try to reconstruct the pre-merge state. If an autostash entry is
104         present, apply it to the worktree.
106 If there were uncommitted worktree changes present when the merge
107 started, `git merge --abort` will in some cases be unable to
108 reconstruct these changes. It is therefore recommended to always
109 commit or stash your changes before running `git merge`.
111 `git merge --abort` is equivalent to `git reset --merge` when
112 `MERGE_HEAD` is present unless `MERGE_AUTOSTASH` is also present in
113 which case `git merge --abort` applies the stash entry to the worktree
114 whereas `git reset --merge` will save the stashed changes in the stash
115 list.
117 --quit::
118         Forget about the current merge in progress. Leave the index
119         and the working tree as-is. If `MERGE_AUTOSTASH` is present, the
120         stash entry will be saved to the stash list.
122 --continue::
123         After a `git merge` stops due to conflicts you can conclude the
124         merge by running `git merge --continue` (see "HOW TO RESOLVE
125         CONFLICTS" section below).
127 <commit>...::
128         Commits, usually other branch heads, to merge into our branch.
129         Specifying more than one commit will create a merge with
130         more than two parents (affectionately called an Octopus merge).
132 If no commit is given from the command line, merge the remote-tracking
133 branches that the current branch is configured to use as its upstream.
134 See also the configuration section of this manual page.
136 When `FETCH_HEAD` (and no other commit) is specified, the branches
137 recorded in the `.git/FETCH_HEAD` file by the previous invocation
138 of `git fetch` for merging are merged to the current branch.
141 PRE-MERGE CHECKS
142 ----------------
144 Before applying outside changes, you should get your own work in
145 good shape and committed locally, so it will not be clobbered if
146 there are conflicts.  See also linkgit:git-stash[1].
147 `git pull` and `git merge` will stop without doing anything when
148 local uncommitted changes overlap with files that `git pull`/`git
149 merge` may need to update.
151 To avoid recording unrelated changes in the merge commit,
152 `git pull` and `git merge` will also abort if there are any changes
153 registered in the index relative to the `HEAD` commit.  (Special
154 narrow exceptions to this rule may exist depending on which merge
155 strategy is in use, but generally, the index must match HEAD.)
157 If all named commits are already ancestors of `HEAD`, `git merge`
158 will exit early with the message "Already up to date."
160 FAST-FORWARD MERGE
161 ------------------
163 Often the current branch head is an ancestor of the named commit.
164 This is the most common case especially when invoked from `git
165 pull`: you are tracking an upstream repository, you have committed
166 no local changes, and now you want to update to a newer upstream
167 revision.  In this case, a new commit is not needed to store the
168 combined history; instead, the `HEAD` (along with the index) is
169 updated to point at the named commit, without creating an extra
170 merge commit.
172 This behavior can be suppressed with the `--no-ff` option.
174 TRUE MERGE
175 ----------
177 Except in a fast-forward merge (see above), the branches to be
178 merged must be tied together by a merge commit that has both of them
179 as its parents.
181 A merged version reconciling the changes from all branches to be
182 merged is committed, and your `HEAD`, index, and working tree are
183 updated to it.  It is possible to have modifications in the working
184 tree as long as they do not overlap; the update will preserve them.
186 When it is not obvious how to reconcile the changes, the following
187 happens:
189 1. The `HEAD` pointer stays the same.
190 2. The `MERGE_HEAD` ref is set to point to the other branch head.
191 3. Paths that merged cleanly are updated both in the index file and
192    in your working tree.
193 4. For conflicting paths, the index file records up to three
194    versions: stage 1 stores the version from the common ancestor,
195    stage 2 from `HEAD`, and stage 3 from `MERGE_HEAD` (you
196    can inspect the stages with `git ls-files -u`).  The working
197    tree files contain the result of the merge operation; i.e. 3-way
198    merge results with familiar conflict markers `<<<` `===` `>>>`.
199 5. A ref named `AUTO_MERGE` is written, pointing to a tree
200    corresponding to the current content of the working tree (including
201    conflict markers for textual conflicts).  Note that this ref is only
202    written when the 'ort' merge strategy is used (the default).
203 6. No other changes are made.  In particular, the local
204    modifications you had before you started merge will stay the
205    same and the index entries for them stay as they were,
206    i.e. matching `HEAD`.
208 If you tried a merge which resulted in complex conflicts and
209 want to start over, you can recover with `git merge --abort`.
211 MERGING TAG
212 -----------
214 When merging an annotated (and possibly signed) tag, Git always
215 creates a merge commit even if a fast-forward merge is possible, and
216 the commit message template is prepared with the tag message.
217 Additionally, if the tag is signed, the signature check is reported
218 as a comment in the message template. See also linkgit:git-tag[1].
220 When you want to just integrate with the work leading to the commit
221 that happens to be tagged, e.g. synchronizing with an upstream
222 release point, you may not want to make an unnecessary merge commit.
224 In such a case, you can "unwrap" the tag yourself before feeding it
225 to `git merge`, or pass `--ff-only` when you do not have any work on
226 your own. e.g.
228 ----
229 git fetch origin
230 git merge v1.2.3^0
231 git merge --ff-only v1.2.3
232 ----
235 HOW CONFLICTS ARE PRESENTED
236 ---------------------------
238 During a merge, the working tree files are updated to reflect the result
239 of the merge.  Among the changes made to the common ancestor's version,
240 non-overlapping ones (that is, you changed an area of the file while the
241 other side left that area intact, or vice versa) are incorporated in the
242 final result verbatim.  When both sides made changes to the same area,
243 however, Git cannot randomly pick one side over the other, and asks you to
244 resolve it by leaving what both sides did to that area.
246 By default, Git uses the same style as the one used by the "merge" program
247 from the RCS suite to present such a conflicted hunk, like this:
249 ------------
250 Here are lines that are either unchanged from the common
251 ancestor, or cleanly resolved because only one side changed,
252 or cleanly resolved because both sides changed the same way.
253 <<<<<<< yours:sample.txt
254 Conflict resolution is hard;
255 let's go shopping.
256 =======
257 Git makes conflict resolution easy.
258 >>>>>>> theirs:sample.txt
259 And here is another line that is cleanly resolved or unmodified.
260 ------------
262 The area where a pair of conflicting changes happened is marked with markers
263 `<<<<<<<`, `=======`, and `>>>>>>>`.  The part before the `=======`
264 is typically your side, and the part afterwards is typically their side.
266 The default format does not show what the original said in the conflicting
267 area.  You cannot tell how many lines are deleted and replaced with
268 Barbie's remark on your side.  The only thing you can tell is that your
269 side wants to say it is hard and you'd prefer to go shopping, while the
270 other side wants to claim it is easy.
272 An alternative style can be used by setting the `merge.conflictStyle`
273 configuration variable to either "diff3" or "zdiff3".  In "diff3"
274 style, the above conflict may look like this:
276 ------------
277 Here are lines that are either unchanged from the common
278 ancestor, or cleanly resolved because only one side changed,
279 <<<<<<< yours:sample.txt
280 or cleanly resolved because both sides changed the same way.
281 Conflict resolution is hard;
282 let's go shopping.
283 ||||||| base:sample.txt
284 or cleanly resolved because both sides changed identically.
285 Conflict resolution is hard.
286 =======
287 or cleanly resolved because both sides changed the same way.
288 Git makes conflict resolution easy.
289 >>>>>>> theirs:sample.txt
290 And here is another line that is cleanly resolved or unmodified.
291 ------------
293 while in "zdiff3" style, it may look like this:
295 ------------
296 Here are lines that are either unchanged from the common
297 ancestor, or cleanly resolved because only one side changed,
298 or cleanly resolved because both sides changed the same way.
299 <<<<<<< yours:sample.txt
300 Conflict resolution is hard;
301 let's go shopping.
302 ||||||| base:sample.txt
303 or cleanly resolved because both sides changed identically.
304 Conflict resolution is hard.
305 =======
306 Git makes conflict resolution easy.
307 >>>>>>> theirs:sample.txt
308 And here is another line that is cleanly resolved or unmodified.
309 ------------
311 In addition to the `<<<<<<<`, `=======`, and `>>>>>>>` markers, it uses
312 another `|||||||` marker that is followed by the original text.  You can
313 tell that the original just stated a fact, and your side simply gave in to
314 that statement and gave up, while the other side tried to have a more
315 positive attitude.  You can sometimes come up with a better resolution by
316 viewing the original.
319 HOW TO RESOLVE CONFLICTS
320 ------------------------
322 After seeing a conflict, you can do two things:
324  * Decide not to merge.  The only clean-ups you need are to reset
325    the index file to the `HEAD` commit to reverse 2. and to clean
326    up working tree changes made by 2. and 3.; `git merge --abort`
327    can be used for this.
329  * Resolve the conflicts.  Git will mark the conflicts in
330    the working tree.  Edit the files into shape and
331    `git add` them to the index.  Use `git commit` or
332    `git merge --continue` to seal the deal. The latter command
333    checks whether there is a (interrupted) merge in progress
334    before calling `git commit`.
336 You can work through the conflict with a number of tools:
338  * Use a mergetool.  `git mergetool` to launch a graphical
339    mergetool which will work through the merge with you.
341  * Look at the diffs.  `git diff` will show a three-way diff,
342    highlighting changes from both the `HEAD` and `MERGE_HEAD`
343    versions. `git diff AUTO_MERGE` will show what changes you've
344    made so far to resolve textual conflicts.
346  * Look at the diffs from each branch. `git log --merge -p <path>`
347    will show diffs first for the `HEAD` version and then the
348    `MERGE_HEAD` version.
350  * Look at the originals.  `git show :1:filename` shows the
351    common ancestor, `git show :2:filename` shows the `HEAD`
352    version, and `git show :3:filename` shows the `MERGE_HEAD`
353    version.
356 EXAMPLES
357 --------
359 * Merge branches `fixes` and `enhancements` on top of
360   the current branch, making an octopus merge:
362 ------------------------------------------------
363 $ git merge fixes enhancements
364 ------------------------------------------------
366 * Merge branch `obsolete` into the current branch, using `ours`
367   merge strategy:
369 ------------------------------------------------
370 $ git merge -s ours obsolete
371 ------------------------------------------------
373 * Merge branch `maint` into the current branch, but do not make
374   a new commit automatically:
376 ------------------------------------------------
377 $ git merge --no-commit maint
378 ------------------------------------------------
380 This can be used when you want to include further changes to the
381 merge, or want to write your own merge commit message.
383 You should refrain from abusing this option to sneak substantial
384 changes into a merge commit.  Small fixups like bumping
385 release/version name would be acceptable.
388 include::merge-strategies.txt[]
390 CONFIGURATION
391 -------------
393 branch.<name>.mergeOptions::
394         Sets default options for merging into branch <name>. The syntax and
395         supported options are the same as those of `git merge`, but option
396         values containing whitespace characters are currently not supported.
398 include::includes/cmd-config-section-rest.txt[]
400 include::config/merge.txt[]
402 SEE ALSO
403 --------
404 linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1],
405 linkgit:gitattributes[5],
406 linkgit:git-reset[1],
407 linkgit:git-diff[1], linkgit:git-ls-files[1],
408 linkgit:git-add[1], linkgit:git-rm[1],
409 linkgit:git-mergetool[1]
413 Part of the linkgit:git[1] suite