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