Documentation/git-merge.txt

   1 git-merge(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-merge - Join two or more development histories together
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git merge' [-n] [--stat] [--no-commit] [--squash] [-s <strategy>]...
  13         [--[no-]rerere-autoupdate] [-m <msg>] <commit>...
  14 'git merge' <msg> HEAD <commit>...
  15
  16 DESCRIPTION
  17 -----------
  18 Incorporates changes from the named commits (since the time their
  19 histories diverged from the current branch) into the current
  20 branch.  This command is used by 'git pull' to incorporate changes
  21 from another repository and can be used by hand to merge changes
  22 from one branch into another.
  23
  24 Assume the following history exists and the current branch is
  25 "`master`":
  26
  27 ------------
  28           A---B---C topic
  29          /
  30     D---E---F---G master
  31 ------------
  32
  33 Then "`git merge topic`" will replay the changes made on the
  34 `topic` branch since it diverged from `master` (i.e., `E`) until
  35 its current commit (`C`) on top of `master`, and record the result
  36 in a new commit along with the names of the two parent commits and
  37 a log message from the user describing the changes.
  38
  39 ------------
  40           A---B---C topic
  41          /         \
  42     D---E---F---G---H master
  43 ------------
  44
  45 The second syntax (<msg> `HEAD` <commit>...) is supported for
  46 historical reasons.  Do not use it from the command line or in
  47 new scripts.  It is the same as `git merge -m <msg> <commit>...`.
  48
  49 *Warning*: Running 'git merge' with uncommitted changes is
  50 discouraged: while possible, it leaves you in a state that is hard to
  51 back out of in the case of a conflict.
  52
  53
  54 OPTIONS
  55 -------
  56 include::merge-options.txt[]
  57
  58 -m <msg>::
  59         Set the commit message to be used for the merge commit (in
  60         case one is created). The 'git fmt-merge-msg' command can be
  61         used to give a good default for automated 'git merge'
  62         invocations.
  63
  64 --rerere-autoupdate::
  65 --no-rerere-autoupdate::
  66         Allow the rerere mechanism to update the index with the
  67         result of auto-conflict resolution if possible.
  68
  69 <commit>...::
  70         Commits, usually other branch heads, to merge into our branch.
  71         You need at least one <commit>.  Specifying more than one
  72         <commit> obviously means you are trying an Octopus.
  73
  74
  75 PRE-MERGE CHECKS
  76 ----------------
  77
  78 Before applying outside changes, you should get your own work in
  79 good shape and committed locally, so it will not be clobbered if
  80 there are conflicts.  See also linkgit:git-stash[1].
  81 'git pull' and 'git merge' will stop without doing anything when
  82 local uncommitted changes overlap with files that 'git pull'/'git
  83 merge' may need to update.
  84
  85 To avoid recording unrelated changes in the merge commit,
  86 'git pull' and 'git merge' will also abort if there are any changes
  87 registered in the index relative to the `HEAD` commit.  (One
  88 exception is when the changed index entries are in the state that
  89 would result from the merge already.)
  90
  91 If all named commits are already ancestors of `HEAD`, 'git merge'
  92 will exit early with the message "Already up-to-date."
  93
  94 FAST-FORWARD MERGE
  95 ------------------
  96
  97 Often the current branch head is an ancestor of the named commit.
  98 This is the most common case especially when invoked from 'git
  99 pull': you are tracking an upstream repository, you have committed
 100 no local changes, and now you want to update to a newer upstream
 101 revision.  In this case, a new commit is not needed to store the
 102 combined history; instead, the `HEAD` (along with the index) is
 103 updated to point at the named commit, without creating an extra
 104 merge commit.
 105
 106 This behavior can be suppressed with the `--no-ff` option.
 107
 108 TRUE MERGE
 109 ----------
 110
 111 Except in a fast-forward merge (see above), the branches to be
 112 merged must be tied together by a merge commit that has both of them
 113 as its parents.
 114
 115 A merged version reconciling the changes from all branches to be
 116 merged is committed, and your `HEAD`, index, and working tree are
 117 updated to it.  It is possible to have modifications in the working
 118 tree as long as they do not overlap; the update will preserve them.
 119
 120 When it is not obvious how to reconcile the changes, the following
 121 happens:
 122
 123 1. The `HEAD` pointer stays the same.
 124 2. The `MERGE_HEAD` ref is set to point to the other branch head.
 125 3. Paths that merged cleanly are updated both in the index file and
 126    in your working tree.
 127 4. For conflicting paths, the index file records up to three
 128    versions: stage 1 stores the version from the common ancestor,
 129    stage 2 from `HEAD`, and stage 3 from `MERGE_HEAD` (you
 130    can inspect the stages with `git ls-files -u`).  The working
 131    tree files contain the result of the "merge" program; i.e. 3-way
 132    merge results with familiar conflict markers `<<<` `===` `>>>`.
 133 5. No other changes are made.  In particular, the local
 134    modifications you had before you started merge will stay the
 135    same and the index entries for them stay as they were,
 136    i.e. matching `HEAD`.
 137
 138 If you tried a merge which resulted in complex conflicts and
 139 want to start over, you can recover with `git reset --merge`.
 140
 141 HOW CONFLICTS ARE PRESENTED
 142 ---------------------------
 143
 144 During a merge, the working tree files are updated to reflect the result
 145 of the merge.  Among the changes made to the common ancestor's version,
 146 non-overlapping ones (that is, you changed an area of the file while the
 147 other side left that area intact, or vice versa) are incorporated in the
 148 final result verbatim.  When both sides made changes to the same area,
 149 however, git cannot randomly pick one side over the other, and asks you to
 150 resolve it by leaving what both sides did to that area.
 151
 152 By default, git uses the same style as that is used by "merge" program
 153 from the RCS suite to present such a conflicted hunk, like this:
 154
 155 ------------
 156 Here are lines that are either unchanged from the common
 157 ancestor, or cleanly resolved because only one side changed.
 158 <<<<<<< yours:sample.txt
 159 Conflict resolution is hard;
 160 let's go shopping.
 161 =======
 162 Git makes conflict resolution easy.
 163 >>>>>>> theirs:sample.txt
 164 And here is another line that is cleanly resolved or unmodified.
 165 ------------
 166
 167 The area where a pair of conflicting changes happened is marked with markers
 168 `<<<<<<<`, `=======`, and `>>>>>>>`.  The part before the `=======`
 169 is typically your side, and the part afterwards is typically their side.
 170
 171 The default format does not show what the original said in the conflicting
 172 area.  You cannot tell how many lines are deleted and replaced with
 173 Barbie's remark on your side.  The only thing you can tell is that your
 174 side wants to say it is hard and you'd prefer to go shopping, while the
 175 other side wants to claim it is easy.
 176
 177 An alternative style can be used by setting the "merge.conflictstyle"
 178 configuration variable to "diff3".  In "diff3" style, the above conflict
 179 may look like this:
 180
 181 ------------
 182 Here are lines that are either unchanged from the common
 183 ancestor, or cleanly resolved because only one side changed.
 184 <<<<<<< yours:sample.txt
 185 Conflict resolution is hard;
 186 let's go shopping.
 187 |||||||
 188 Conflict resolution is hard.
 189 =======
 190 Git makes conflict resolution easy.
 191 >>>>>>> theirs:sample.txt
 192 And here is another line that is cleanly resolved or unmodified.
 193 ------------
 194
 195 In addition to the `<<<<<<<`, `=======`, and `>>>>>>>` markers, it uses
 196 another `|||||||` marker that is followed by the original text.  You can
 197 tell that the original just stated a fact, and your side simply gave in to
 198 that statement and gave up, while the other side tried to have a more
 199 positive attitude.  You can sometimes come up with a better resolution by
 200 viewing the original.
 201
 202
 203 HOW TO RESOLVE CONFLICTS
 204 ------------------------
 205
 206 After seeing a conflict, you can do two things:
 207
 208  * Decide not to merge.  The only clean-ups you need are to reset
 209    the index file to the `HEAD` commit to reverse 2. and to clean
 210    up working tree changes made by 2. and 3.; `git-reset --hard` can
 211    be used for this.
 212
 213  * Resolve the conflicts.  Git will mark the conflicts in
 214    the working tree.  Edit the files into shape and
 215    'git add' them to the index.  Use 'git commit' to seal the deal.
 216
 217 You can work through the conflict with a number of tools:
 218
 219  * Use a mergetool.  `git mergetool` to launch a graphical
 220    mergetool which will work you through the merge.
 221
 222  * Look at the diffs.  `git diff` will show a three-way diff,
 223    highlighting changes from both the `HEAD` and `MERGE_HEAD`
 224    versions.
 225
 226  * Look at the diffs from each branch. `git log --merge -p <path>`
 227    will show diffs first for the `HEAD` version and then the
 228    `MERGE_HEAD` version.
 229
 230  * Look at the originals.  `git show :1:filename` shows the
 231    common ancestor, `git show :2:filename` shows the `HEAD`
 232    version, and `git show :3:filename` shows the `MERGE_HEAD`
 233    version.
 234
 235
 236 EXAMPLES
 237 --------
 238
 239 * Merge branches `fixes` and `enhancements` on top of
 240   the current branch, making an octopus merge:
 241 +
 242 ------------------------------------------------
 243 $ git merge fixes enhancements
 244 ------------------------------------------------
 245
 246 * Merge branch `obsolete` into the current branch, using `ours`
 247   merge strategy:
 248 +
 249 ------------------------------------------------
 250 $ git merge -s ours obsolete
 251 ------------------------------------------------
 252
 253 * Merge branch `maint` into the current branch, but do not make
 254   a new commit automatically:
 255 +
 256 ------------------------------------------------
 257 $ git merge --no-commit maint
 258 ------------------------------------------------
 259 +
 260 This can be used when you want to include further changes to the
 261 merge, or want to write your own merge commit message.
 262 +
 263 You should refrain from abusing this option to sneak substantial
 264 changes into a merge commit.  Small fixups like bumping
 265 release/version name would be acceptable.
 266
 267
 268 include::merge-strategies.txt[]
 269
 270 CONFIGURATION
 271 -------------
 272 include::merge-config.txt[]
 273
 274 branch.<name>.mergeoptions::
 275         Sets default options for merging into branch <name>. The syntax and
 276         supported options are the same as those of 'git merge', but option
 277         values containing whitespace characters are currently not supported.
 278
 279 SEE ALSO
 280 --------
 281 linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1],
 282 linkgit:gitattributes[5],
 283 linkgit:git-reset[1],
 284 linkgit:git-diff[1], linkgit:git-ls-files[1],
 285 linkgit:git-add[1], linkgit:git-rm[1],
 286 linkgit:git-mergetool[1]
 287
 288 Author
 289 ------
 290 Written by Junio C Hamano <gitster@pobox.com>
 291
 292
 293 Documentation
 294 --------------
 295 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 296
 297 GIT
 298 ---
 299 Part of the linkgit:git[1] suite