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] [--[no-]edit]
  13         [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
  14         [--[no-]rerere-autoupdate] [-m <msg>] [<commit>...]
  15 'git merge' <msg> HEAD <commit>...
  16 'git merge' --abort
  17
  18 DESCRIPTION
  19 -----------
  20 Incorporates changes from the named commits (since the time their
  21 histories diverged from the current branch) into the current
  22 branch.  This command is used by 'git pull' to incorporate changes
  23 from another repository and can be used by hand to merge changes
  24 from one branch into another.
  25
  26 Assume the following history exists and the current branch is
  27 "`master`":
  28
  29 ------------
  30           A---B---C topic
  31          /
  32     D---E---F---G master
  33 ------------
  34
  35 Then "`git merge topic`" will replay the changes made on the
  36 `topic` branch since it diverged from `master` (i.e., `E`) until
  37 its current commit (`C`) on top of `master`, and record the result
  38 in a new commit along with the names of the two parent commits and
  39 a log message from the user describing the changes.
  40
  41 ------------
  42           A---B---C topic
  43          /         \
  44     D---E---F---G---H master
  45 ------------
  46
  47 The second syntax (<msg> `HEAD` <commit>...) is supported for
  48 historical reasons.  Do not use it from the command line or in
  49 new scripts.  It is the same as `git merge -m <msg> <commit>...`.
  50
  51 The third syntax ("`git merge --abort`") can only be run after the
  52 merge has resulted in conflicts. 'git merge --abort' will abort the
  53 merge process and try to reconstruct the pre-merge state. However,
  54 if there were uncommitted changes when the merge started (and
  55 especially if those changes were further modified after the merge
  56 was started), 'git merge --abort' will in some cases be unable to
  57 reconstruct the original (pre-merge) changes. Therefore:
  58
  59 *Warning*: Running 'git merge' with non-trivial uncommitted changes is
  60 discouraged: while possible, it may leave you in a state that is hard to
  61 back out of in the case of a conflict.
  62
  63
  64 OPTIONS
  65 -------
  66 include::merge-options.txt[]
  67
  68 -S[<keyid>]::
  69 --gpg-sign[=<keyid>]::
  70         GPG-sign the resulting merge commit. The `keyid` argument is
  71         optional and defaults to the committer identity; if specified,
  72         it must be stuck to the option without a space.
  73
  74 -m <msg>::
  75         Set the commit message to be used for the merge commit (in
  76         case one is created).
  77 +
  78 If `--log` is specified, a shortlog of the commits being merged
  79 will be appended to the specified message.
  80 +
  81 The 'git fmt-merge-msg' command can be
  82 used to give a good default for automated 'git merge'
  83 invocations. The automated message can include the branch description.
  84
  85 --[no-]rerere-autoupdate::
  86         Allow the rerere mechanism to update the index with the
  87         result of auto-conflict resolution if possible.
  88
  89 --abort::
  90         Abort the current conflict resolution process, and
  91         try to reconstruct the pre-merge state.
  92 +
  93 If there were uncommitted worktree changes present when the merge
  94 started, 'git merge --abort' will in some cases be unable to
  95 reconstruct these changes. It is therefore recommended to always
  96 commit or stash your changes before running 'git merge'.
  97 +
  98 'git merge --abort' is equivalent to 'git reset --merge' when
  99 `MERGE_HEAD` is present.
 100
 101 --allow-unrelated-histories::
 102         By default, `git merge` command refuses to merge histories
 103         that do not share a common ancestor.  This option can be
 104         used to override this safety when merging histories of two
 105         projects that started their lives independently.  As that is
 106         a very rare occasion, no configuration variable to enable
 107         this by default exists and will not be added, and the list
 108         of options at the top of this documentation does not mention
 109         this option.  Also `git pull` does not pass this option down
 110         to `git merge` (instead, you `git fetch` first, examine what
 111         you will be merging and then `git merge` locally with this
 112         option).
 113
 114 <commit>...::
 115         Commits, usually other branch heads, to merge into our branch.
 116         Specifying more than one commit will create a merge with
 117         more than two parents (affectionately called an Octopus merge).
 118 +
 119 If no commit is given from the command line, merge the remote-tracking
 120 branches that the current branch is configured to use as its upstream.
 121 See also the configuration section of this manual page.
 122 +
 123 When `FETCH_HEAD` (and no other commit) is specified, the branches
 124 recorded in the `.git/FETCH_HEAD` file by the previous invocation
 125 of `git fetch` for merging are merged to the current branch.
 126
 127
 128 PRE-MERGE CHECKS
 129 ----------------
 130
 131 Before applying outside changes, you should get your own work in
 132 good shape and committed locally, so it will not be clobbered if
 133 there are conflicts.  See also linkgit:git-stash[1].
 134 'git pull' and 'git merge' will stop without doing anything when
 135 local uncommitted changes overlap with files that 'git pull'/'git
 136 merge' may need to update.
 137
 138 To avoid recording unrelated changes in the merge commit,
 139 'git pull' and 'git merge' will also abort if there are any changes
 140 registered in the index relative to the `HEAD` commit.  (One
 141 exception is when the changed index entries are in the state that
 142 would result from the merge already.)
 143
 144 If all named commits are already ancestors of `HEAD`, 'git merge'
 145 will exit early with the message "Already up-to-date."
 146
 147 FAST-FORWARD MERGE
 148 ------------------
 149
 150 Often the current branch head is an ancestor of the named commit.
 151 This is the most common case especially when invoked from 'git
 152 pull': you are tracking an upstream repository, you have committed
 153 no local changes, and now you want to update to a newer upstream
 154 revision.  In this case, a new commit is not needed to store the
 155 combined history; instead, the `HEAD` (along with the index) is
 156 updated to point at the named commit, without creating an extra
 157 merge commit.
 158
 159 This behavior can be suppressed with the `--no-ff` option.
 160
 161 TRUE MERGE
 162 ----------
 163
 164 Except in a fast-forward merge (see above), the branches to be
 165 merged must be tied together by a merge commit that has both of them
 166 as its parents.
 167
 168 A merged version reconciling the changes from all branches to be
 169 merged is committed, and your `HEAD`, index, and working tree are
 170 updated to it.  It is possible to have modifications in the working
 171 tree as long as they do not overlap; the update will preserve them.
 172
 173 When it is not obvious how to reconcile the changes, the following
 174 happens:
 175
 176 1. The `HEAD` pointer stays the same.
 177 2. The `MERGE_HEAD` ref is set to point to the other branch head.
 178 3. Paths that merged cleanly are updated both in the index file and
 179    in your working tree.
 180 4. For conflicting paths, the index file records up to three
 181    versions: stage 1 stores the version from the common ancestor,
 182    stage 2 from `HEAD`, and stage 3 from `MERGE_HEAD` (you
 183    can inspect the stages with `git ls-files -u`).  The working
 184    tree files contain the result of the "merge" program; i.e. 3-way
 185    merge results with familiar conflict markers `<<<` `===` `>>>`.
 186 5. No other changes are made.  In particular, the local
 187    modifications you had before you started merge will stay the
 188    same and the index entries for them stay as they were,
 189    i.e. matching `HEAD`.
 190
 191 If you tried a merge which resulted in complex conflicts and
 192 want to start over, you can recover with `git merge --abort`.
 193
 194 MERGING TAG
 195 -----------
 196
 197 When merging an annotated (and possibly signed) tag, Git always
 198 creates a merge commit even if a fast-forward merge is possible, and
 199 the commit message template is prepared with the tag message.
 200 Additionally, if the tag is signed, the signature check is reported
 201 as a comment in the message template. See also linkgit:git-tag[1].
 202
 203 When you want to just integrate with the work leading to the commit
 204 that happens to be tagged, e.g. synchronizing with an upstream
 205 release point, you may not want to make an unnecessary merge commit.
 206
 207 In such a case, you can "unwrap" the tag yourself before feeding it
 208 to `git merge`, or pass `--ff-only` when you do not have any work on
 209 your own. e.g.
 210
 211 ----
 212 git fetch origin
 213 git merge v1.2.3^0
 214 git merge --ff-only v1.2.3
 215 ----
 216
 217
 218 HOW CONFLICTS ARE PRESENTED
 219 ---------------------------
 220
 221 During a merge, the working tree files are updated to reflect the result
 222 of the merge.  Among the changes made to the common ancestor's version,
 223 non-overlapping ones (that is, you changed an area of the file while the
 224 other side left that area intact, or vice versa) are incorporated in the
 225 final result verbatim.  When both sides made changes to the same area,
 226 however, Git cannot randomly pick one side over the other, and asks you to
 227 resolve it by leaving what both sides did to that area.
 228
 229 By default, Git uses the same style as the one used by the "merge" program
 230 from the RCS suite to present such a conflicted hunk, like this:
 231
 232 ------------
 233 Here are lines that are either unchanged from the common
 234 ancestor, or cleanly resolved because only one side changed.
 235 <<<<<<< yours:sample.txt
 236 Conflict resolution is hard;
 237 let's go shopping.
 238 =======
 239 Git makes conflict resolution easy.
 240 >>>>>>> theirs:sample.txt
 241 And here is another line that is cleanly resolved or unmodified.
 242 ------------
 243
 244 The area where a pair of conflicting changes happened is marked with markers
 245 `<<<<<<<`, `=======`, and `>>>>>>>`.  The part before the `=======`
 246 is typically your side, and the part afterwards is typically their side.
 247
 248 The default format does not show what the original said in the conflicting
 249 area.  You cannot tell how many lines are deleted and replaced with
 250 Barbie's remark on your side.  The only thing you can tell is that your
 251 side wants to say it is hard and you'd prefer to go shopping, while the
 252 other side wants to claim it is easy.
 253
 254 An alternative style can be used by setting the "merge.conflictStyle"
 255 configuration variable to "diff3".  In "diff3" style, the above conflict
 256 may look like this:
 257
 258 ------------
 259 Here are lines that are either unchanged from the common
 260 ancestor, or cleanly resolved because only one side changed.
 261 <<<<<<< yours:sample.txt
 262 Conflict resolution is hard;
 263 let's go shopping.
 264 |||||||
 265 Conflict resolution is hard.
 266 =======
 267 Git makes conflict resolution easy.
 268 >>>>>>> theirs:sample.txt
 269 And here is another line that is cleanly resolved or unmodified.
 270 ------------
 271
 272 In addition to the `<<<<<<<`, `=======`, and `>>>>>>>` markers, it uses
 273 another `|||||||` marker that is followed by the original text.  You can
 274 tell that the original just stated a fact, and your side simply gave in to
 275 that statement and gave up, while the other side tried to have a more
 276 positive attitude.  You can sometimes come up with a better resolution by
 277 viewing the original.
 278
 279
 280 HOW TO RESOLVE CONFLICTS
 281 ------------------------
 282
 283 After seeing a conflict, you can do two things:
 284
 285  * Decide not to merge.  The only clean-ups you need are to reset
 286    the index file to the `HEAD` commit to reverse 2. and to clean
 287    up working tree changes made by 2. and 3.; `git merge --abort`
 288    can be used for this.
 289
 290  * Resolve the conflicts.  Git will mark the conflicts in
 291    the working tree.  Edit the files into shape and
 292    'git add' them to the index.  Use 'git commit' to seal the deal.
 293
 294 You can work through the conflict with a number of tools:
 295
 296  * Use a mergetool.  `git mergetool` to launch a graphical
 297    mergetool which will work you through the merge.
 298
 299  * Look at the diffs.  `git diff` will show a three-way diff,
 300    highlighting changes from both the `HEAD` and `MERGE_HEAD`
 301    versions.
 302
 303  * Look at the diffs from each branch. `git log --merge -p <path>`
 304    will show diffs first for the `HEAD` version and then the
 305    `MERGE_HEAD` version.
 306
 307  * Look at the originals.  `git show :1:filename` shows the
 308    common ancestor, `git show :2:filename` shows the `HEAD`
 309    version, and `git show :3:filename` shows the `MERGE_HEAD`
 310    version.
 311
 312
 313 EXAMPLES
 314 --------
 315
 316 * Merge branches `fixes` and `enhancements` on top of
 317   the current branch, making an octopus merge:
 318 +
 319 ------------------------------------------------
 320 $ git merge fixes enhancements
 321 ------------------------------------------------
 322
 323 * Merge branch `obsolete` into the current branch, using `ours`
 324   merge strategy:
 325 +
 326 ------------------------------------------------
 327 $ git merge -s ours obsolete
 328 ------------------------------------------------
 329
 330 * Merge branch `maint` into the current branch, but do not make
 331   a new commit automatically:
 332 +
 333 ------------------------------------------------
 334 $ git merge --no-commit maint
 335 ------------------------------------------------
 336 +
 337 This can be used when you want to include further changes to the
 338 merge, or want to write your own merge commit message.
 339 +
 340 You should refrain from abusing this option to sneak substantial
 341 changes into a merge commit.  Small fixups like bumping
 342 release/version name would be acceptable.
 343
 344
 345 include::merge-strategies.txt[]
 346
 347 CONFIGURATION
 348 -------------
 349 include::merge-config.txt[]
 350
 351 branch.<name>.mergeOptions::
 352         Sets default options for merging into branch <name>. The syntax and
 353         supported options are the same as those of 'git merge', but option
 354         values containing whitespace characters are currently not supported.
 355
 356 SEE ALSO
 357 --------
 358 linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1],
 359 linkgit:gitattributes[5],
 360 linkgit:git-reset[1],
 361 linkgit:git-diff[1], linkgit:git-ls-files[1],
 362 linkgit:git-add[1], linkgit:git-rm[1],
 363 linkgit:git-mergetool[1]
 364
 365 GIT
 366 ---
 367 Part of the linkgit:git[1] suite