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         [-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 <commit>...::
  65         Commits, usually other branch heads, to merge into our branch.
  66         You need at least one <commit>.  Specifying more than one
  67         <commit> obviously means you are trying an Octopus.
  68
  69
  70 PRE-MERGE CHECKS
  71 ----------------
  72
  73 Before applying outside changes, you should get your own work in
  74 good shape and committed locally, so it will not be clobbered if
  75 there are conflicts.  See also linkgit:git-stash[1].
  76 'git pull' and 'git merge' will stop without doing anything when
  77 local uncommitted changes overlap with files that 'git pull'/'git
  78 merge' may need to update.
  79
  80 To avoid recording unrelated changes in the merge commit,
  81 'git pull' and 'git merge' will also abort if there are any changes
  82 registered in the index relative to the `HEAD` commit.  (One
  83 exception is when the changed index entries are in the state that
  84 would result from the merge already.)
  85
  86 If all named commits are already ancestors of `HEAD`, 'git merge'
  87 will exit early with the message "Already up-to-date."
  88
  89 HOW MERGE WORKS
  90 ---------------
  91
  92 A merge is always between the current `HEAD` and one or more
  93 commits (usually a branch head or tag).
  94
  95 Two kinds of merge can happen:
  96
  97 * `HEAD` is already contained in the merged commit. This is the
  98   most common case especially when invoked from 'git pull':
  99   you are tracking an upstream repository, have committed no local
 100   changes and now you want to update to a newer upstream revision.
 101   Your `HEAD` (and the index) is updated to point at the merged
 102   commit, without creating an extra merge commit.  This is
 103   called "Fast-forward".
 104
 105 * Both the merged commit and `HEAD` are independent and must be
 106   tied together by a merge commit that has both of them as its parents.
 107   The rest of this section describes this "True merge" case.
 108
 109 The chosen merge strategy merges the two commits into a single
 110 new source tree.
 111 When things merge cleanly, this is what happens:
 112
 113 1. The results are updated both in the index file and in your
 114    working tree;
 115 2. Index file is written out as a tree;
 116 3. The tree gets committed; and
 117 4. The `HEAD` pointer gets advanced.
 118
 119 Because of 2., we require that the original state of the index
 120 file matches exactly the current `HEAD` commit; otherwise we
 121 will write out your local changes already registered in your
 122 index file along with the merge result, which is not good.
 123 Because 1. involves only those paths differing between your
 124 branch and the branch you are merging
 125 (which is typically a fraction of the whole tree), you can
 126 have local modifications in your working tree as long as they do
 127 not overlap with what the merge updates.
 128
 129 When there are conflicts, the following happens:
 130
 131 1. `HEAD` stays the same.
 132
 133 2. Cleanly merged paths are updated both in the index file and
 134    in your working tree.
 135
 136 3. For conflicting paths, the index file records up to three
 137    versions; stage1 stores the version from the common ancestor,
 138    stage2 from `HEAD`, and stage3 from the other branch (you
 139    can inspect the stages with `git ls-files -u`).  The working
 140    tree files contain the result of the "merge" program; i.e. 3-way
 141    merge results with familiar conflict markers `<<< === >>>`.
 142
 143 4. No other changes are done.  In particular, the local
 144    modifications you had before you started merge will stay the
 145    same and the index entries for them stay as they were,
 146    i.e. matching `HEAD`.
 147
 148 If you tried a merge which resulted in complex conflicts and
 149 want to start over, you can recover with `git reset --merge`.
 150
 151 HOW CONFLICTS ARE PRESENTED
 152 ---------------------------
 153
 154 During a merge, the working tree files are updated to reflect the result
 155 of the merge.  Among the changes made to the common ancestor's version,
 156 non-overlapping ones (that is, you changed an area of the file while the
 157 other side left that area intact, or vice versa) are incorporated in the
 158 final result verbatim.  When both sides made changes to the same area,
 159 however, git cannot randomly pick one side over the other, and asks you to
 160 resolve it by leaving what both sides did to that area.
 161
 162 By default, git uses the same style as that is used by "merge" program
 163 from the RCS suite to present such a conflicted hunk, like this:
 164
 165 ------------
 166 Here are lines that are either unchanged from the common
 167 ancestor, or cleanly resolved because only one side changed.
 168 <<<<<<< yours:sample.txt
 169 Conflict resolution is hard;
 170 let's go shopping.
 171 =======
 172 Git makes conflict resolution easy.
 173 >>>>>>> theirs:sample.txt
 174 And here is another line that is cleanly resolved or unmodified.
 175 ------------
 176
 177 The area where a pair of conflicting changes happened is marked with markers
 178 `<<<<<<<`, `=======`, and `>>>>>>>`.  The part before the `=======`
 179 is typically your side, and the part afterwards is typically their side.
 180
 181 The default format does not show what the original said in the conflicting
 182 area.  You cannot tell how many lines are deleted and replaced with
 183 Barbie's remark on your side.  The only thing you can tell is that your
 184 side wants to say it is hard and you'd prefer to go shopping, while the
 185 other side wants to claim it is easy.
 186
 187 An alternative style can be used by setting the "merge.conflictstyle"
 188 configuration variable to "diff3".  In "diff3" style, the above conflict
 189 may look like this:
 190
 191 ------------
 192 Here are lines that are either unchanged from the common
 193 ancestor, or cleanly resolved because only one side changed.
 194 <<<<<<< yours:sample.txt
 195 Conflict resolution is hard;
 196 let's go shopping.
 197 |||||||
 198 Conflict resolution is hard.
 199 =======
 200 Git makes conflict resolution easy.
 201 >>>>>>> theirs:sample.txt
 202 And here is another line that is cleanly resolved or unmodified.
 203 ------------
 204
 205 In addition to the `<<<<<<<`, `=======`, and `>>>>>>>` markers, it uses
 206 another `|||||||` marker that is followed by the original text.  You can
 207 tell that the original just stated a fact, and your side simply gave in to
 208 that statement and gave up, while the other side tried to have a more
 209 positive attitude.  You can sometimes come up with a better resolution by
 210 viewing the original.
 211
 212
 213 HOW TO RESOLVE CONFLICTS
 214 ------------------------
 215
 216 After seeing a conflict, you can do two things:
 217
 218  * Decide not to merge.  The only clean-ups you need are to reset
 219    the index file to the `HEAD` commit to reverse 2. and to clean
 220    up working tree changes made by 2. and 3.; `git-reset --hard` can
 221    be used for this.
 222
 223  * Resolve the conflicts.  Git will mark the conflicts in
 224    the working tree.  Edit the files into shape and
 225    'git add' them to the index.  Use 'git commit' to seal the deal.
 226
 227 You can work through the conflict with a number of tools:
 228
 229  * Use a mergetool.  `git mergetool` to launch a graphical
 230    mergetool which will work you through the merge.
 231
 232  * Look at the diffs.  `git diff` will show a three-way diff,
 233    highlighting changes from both the HEAD and their versions.
 234
 235  * Look at the diffs on their own. `git log --merge -p <path>`
 236    will show diffs first for the HEAD version and then
 237    their version.
 238
 239  * Look at the originals.  `git show :1:filename` shows the
 240    common ancestor, `git show :2:filename` shows the HEAD
 241    version and `git show :3:filename` shows their version.
 242
 243
 244 EXAMPLES
 245 --------
 246
 247 * Merge branches `fixes` and `enhancements` on top of
 248   the current branch, making an octopus merge:
 249 +
 250 ------------------------------------------------
 251 $ git merge fixes enhancements
 252 ------------------------------------------------
 253
 254 * Merge branch `obsolete` into the current branch, using `ours`
 255   merge strategy:
 256 +
 257 ------------------------------------------------
 258 $ git merge -s ours obsolete
 259 ------------------------------------------------
 260
 261 * Merge branch `maint` into the current branch, but do not make
 262   a new commit automatically:
 263 +
 264 ------------------------------------------------
 265 $ git merge --no-commit maint
 266 ------------------------------------------------
 267 +
 268 This can be used when you want to include further changes to the
 269 merge, or want to write your own merge commit message.
 270 +
 271 You should refrain from abusing this option to sneak substantial
 272 changes into a merge commit.  Small fixups like bumping
 273 release/version name would be acceptable.
 274
 275
 276 include::merge-strategies.txt[]
 277
 278 CONFIGURATION
 279 -------------
 280 include::merge-config.txt[]
 281
 282 branch.<name>.mergeoptions::
 283         Sets default options for merging into branch <name>. The syntax and
 284         supported options are the same as those of 'git merge', but option
 285         values containing whitespace characters are currently not supported.
 286
 287 SEE ALSO
 288 --------
 289 linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1],
 290 linkgit:gitattributes[5],
 291 linkgit:git-reset[1],
 292 linkgit:git-diff[1], linkgit:git-ls-files[1],
 293 linkgit:git-add[1], linkgit:git-rm[1],
 294 linkgit:git-mergetool[1]
 295
 296 Author
 297 ------
 298 Written by Junio C Hamano <gitster@pobox.com>
 299
 300
 301 Documentation
 302 --------------
 303 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 304
 305 GIT
 306 ---
 307 Part of the linkgit:git[1] suite