man1/git-merge.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-MERGE" 1 "" "" ""
  21 .SH NAME
  22 git-merge \- Grand Unified Merge Driver
  23 .SH "SYNOPSIS"
  24
  25
  26 git\-merge [\-n] [\-\-no\-commit] [\-s <strategy>]... <msg> <head> <remote> <remote>...
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 This is the top\-level user interface to the merge machinery which drives multiple merge strategy scripts\&.
  32
  33 .SH "OPTIONS"
  34
  35 .TP
  36 \-n, \-\-no\-summary
  37 Do not show diffstat at the end of the merge\&.
  38
  39 .TP
  40 \-\-no\-commit
  41 Perform the merge but pretend the merge failed and do not autocommit, to give the user a chance to inspect and further tweak the merge result before committing\&.
  42
  43 .TP
  44 \-s <strategy>, \-\-strategy=<strategy>
  45 Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried\&. If there is no \-s option, a built\-in list of strategies is used instead (git\-merge\-recursive when merging a single head, git\-merge\-octopus otherwise)\&.
  46
  47 .TP
  48 <msg>
  49 The commit message to be used for the merge commit (in case it is created)\&. The git\-fmt\-merge\-msg script can be used to give a good default for automated git\-merge invocations\&.
  50
  51 .TP
  52 <head>
  53 our branch head commit\&.
  54
  55 .TP
  56 <remote>
  57 other branch head merged into our branch\&. You need at least one <remote>\&. Specifying more than one <remote> obviously means you are trying an Octopus\&.
  58
  59 .SH "MERGE STRATEGIES"
  60
  61 .TP
  62 resolve
  63 This can only resolve two heads (i\&.e\&. the current branch and another branch you pulled from) using 3\-way merge algorithm\&. It tries to carefully detect criss\-cross merge ambiguities and is considered generally safe and fast\&.
  64
  65 .TP
  66 recursive
  67 This can only resolve two heads using 3\-way merge algorithm\&. When there are more than one common ancestors that can be used for 3\-way merge, it creates a merged tree of the common ancestors and uses that as the reference tree for the 3\-way merge\&. This has been reported to result in fewer merge conflicts without causing mis\-merges by tests done on actual merge commits taken from Linux 2\&.6 kernel development history\&. Additionally this can detect and handle merges involving renames\&. This is the default merge strategy when pulling or merging one branch\&.
  68
  69 .TP
  70 octopus
  71 This resolves more than two\-head case, but refuses to do complex merge that needs manual resolution\&. It is primarily meant to be used for bundling topic branch heads together\&. This is the default merge strategy when pulling or merging more than one branches\&.
  72
  73 .TP
  74 ours
  75 This resolves any number of heads, but the result of the merge is always the current branch head\&. It is meant to be used to supersede old development history of side branches\&.
  76
  77
  78 If you tried a merge which resulted in a complex conflicts and would want to start over, you can recover with \fBgit\-reset\fR(1)\&.
  79
  80 .SH "HOW MERGE WORKS"
  81
  82
  83 A merge is always between the current HEAD and one or more remote branch heads, and the index file must exactly match the tree of HEAD commit (i\&.e\&. the contents of the last commit) when it happens\&. In other words, git\-diff \-\-cached HEAD must report no changes\&.
  84
  85 .RS
  86 .Sh "Note"
  87
  88
  89 This is a bit of lie\&. In certain special cases, your index are allowed to be different from the tree of HEAD commit\&. The most notable case is when your HEAD commit is already ahead of what is being merged, in which case your index can have arbitrary difference from your HEAD commit\&. Otherwise, your index entries are allowed have differences from your HEAD commit that match the result of trivial merge (e\&.g\&. you received the same patch from external source to produce the same result as what you are merging)\&. For example, if a path did not exist in the common ancestor and your head commit but exists in the tree you are merging into your repository, and if you already happen to have that path exactly in your index, the merge does not have to fail\&.
  90
  91 .RE
  92
  93
  94 Otherwise, merge will refuse to do any harm to your repository (that is, it may fetch the objects from remote, and it may even update the local branch used to keep track of the remote branch with git pull remote rbranch:lbranch, but your working tree, \&.git/HEAD pointer and index file are left intact)\&.
  95
  96
  97 You may have local modifications in the working tree files\&. In other words, git\-diff is allowed to report changes\&. However, the merge uses your working tree as the working area, and in order to prevent the merge operation from losing such changes, it makes sure that they do not interfere with the merge\&. Those complex tables in read\-tree documentation define what it means for a path to "interfere with the merge"\&. And if your local modifications interfere with the merge, again, it stops before touching anything\&.
  98
  99
 100 So in the above two "failed merge" case, you do not have to worry about lossage of data \-\-\- you simply were not ready to do a merge, so no merge happened at all\&. You may want to finish whatever you were in the middle of doing, and retry the same pull after you are done and ready\&.
 101
 102
 103 When things cleanly merge, these things happen:
 104
 105 .TP 3
 106 1.
 107 the results are updated both in the index file and in your working tree,
 108 .TP
 109 2.
 110 index file is written out as a tree,
 111 .TP
 112 3.
 113 the tree gets committed, and
 114 .TP
 115 4.
 116 the HEAD pointer gets advanced\&.
 117 .LP
 118
 119
 120 Because of 2\&., we require that the original state of the index file to match exactly the current HEAD commit; otherwise we will write out your local changes already registered in your index file along with the merge result, which is not good\&. Because 1\&. involves only the paths different between your branch and the remote branch you are pulling from during the merge (which is typically a fraction of the whole tree), you can have local modifications in your working tree as long as they do not overlap with what the merge updates\&.
 121
 122
 123 When there are conflicts, these things happen:
 124
 125 .TP 3
 126 1.
 127  HEAD stays the same\&.
 128 .TP
 129 2.
 130 Cleanly merged paths are updated both in the index file and in your working tree\&.
 131 .TP
 132 3.
 133 For conflicting paths, the index file records up to three versions; stage1 stores the version from the common ancestor, stage2 from HEAD, and stage3 from the remote branch (you can inspect the stages with git\-ls\-files \-u)\&. The working tree files have the result of "merge" program; i\&.e\&. 3\-way merge result with familiar conflict markers <<< === >>>\&.
 134 .TP
 135 4.
 136 No other changes are done\&. In particular, the local modifications you had before you started merge will stay the same and the index entries for them stay as they were, i\&.e\&. matching HEAD\&.
 137 .LP
 138
 139
 140 After seeing a conflict, you can do two things:
 141
 142 .TP 3
 143 \(bu
 144 Decide not to merge\&. The only clean\-up you need are to reset the index file to the HEAD commit to reverse 2\&. and to clean up working tree changes made by 2\&. and 3\&.; git\-reset can be used for this\&.
 145 .TP
 146 \(bu
 147 Resolve the conflicts\&. git\-diff would report only the conflicting paths because of the above 2\&. and 3\&.\&. Edit the working tree files into a desirable shape, git\-update\-index them, to make the index file contain what the merge result should be, and run git\-commit to commit the result\&.
 148 .LP
 149
 150 .SH "SEE ALSO"
 151
 152
 153 \fBgit\-fmt\-merge\-msg\fR(1), \fBgit\-pull\fR(1)
 154
 155 .SH "AUTHOR"
 156
 157
 158 Written by Junio C Hamano <junkio@cox\&.net>
 159
 160 .SH "DOCUMENTATION"
 161
 162
 163 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 164
 165 .SH "GIT"
 166
 167
 168 Part of the \fBgit\fR(7) suite
 169