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