3 Perform the merge and commit the result. This option can
4 be used to override --no-commit.
6 Only useful when merging.
9 With --no-commit perform the merge and stop just before creating
10 a merge commit, to give the user a chance to inspect and further
11 tweak the merge result before committing.
13 Note that fast-forward updates do not create a merge commit and
14 therefore there is no way to stop those merges with --no-commit.
15 Thus, if you want to ensure your branch is not changed or updated
16 by the merge command, use --no-ff with --no-commit.
21 Invoke an editor before committing successful mechanical merge to
22 further edit the auto-generated merge message, so that the user
23 can explain and justify the merge. The `--no-edit` option can be
24 used to accept the auto-generated message (this is generally
27 The `--edit` (or `-e`) option is still useful if you are
28 giving a draft message with the `-m` option from the command line
29 and want to edit it in the editor.
32 Older scripts may depend on the historical behaviour of not allowing the
33 user to edit the merge log message. They will see an editor opened when
34 they run `git merge`. To make it easier to adjust such scripts to the
35 updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
36 set to `no` at the beginning of them.
39 This option determines how the merge message will be cleaned up before
40 committing. See linkgit:git-commit[1] for more details. In addition, if
41 the '<mode>' is given a value of `scissors`, scissors will be appended
42 to `MERGE_MSG` before being passed on to the commit machinery in the
43 case of a merge conflict.
49 Specifies how a merge is handled when the merged-in history is
50 already a descendant of the current history. `--ff` is the
51 default unless merging an annotated (and possibly signed) tag
52 that is not stored in its natural place in the `refs/tags/`
53 hierarchy, in which case `--no-ff` is assumed.
57 Only update to the new history if there is no divergent local
58 history. This is the default when no method for reconciling
59 divergent histories is provided (via the --rebase=* flags).
63 When merging rather than rebasing, specifies how a merge is
64 handled when the merged-in history is already a descendant of
65 the current history. If merging is requested, `--ff` is the
66 default unless merging an annotated (and possibly signed) tag
67 that is not stored in its natural place in the `refs/tags/`
68 hierarchy, in which case `--no-ff` is assumed.
71 With `--ff`, when possible resolve the merge as a fast-forward (only
72 update the branch pointer to match the merged branch; do not create a
73 merge commit). When not possible (when the merged-in history is not a
74 descendant of the current history), create a merge commit.
76 With `--no-ff`, create a merge commit in all cases, even when the merge
77 could instead be resolved as a fast-forward.
80 With `--ff-only`, resolve the merge as a fast-forward when possible.
81 When not possible, refuse to merge and exit with a non-zero status.
85 --gpg-sign[=<keyid>]::
87 GPG-sign the resulting merge commit. The `keyid` argument is
88 optional and defaults to the committer identity; if specified,
89 it must be stuck to the option without a space. `--no-gpg-sign`
90 is useful to countermand both `commit.gpgSign` configuration variable,
91 and earlier `--gpg-sign`.
95 In addition to branch names, populate the log message with
96 one-line descriptions from at most <n> actual commits that are being
97 merged. See also linkgit:git-fmt-merge-msg[1].
99 Only useful when merging.
102 With --no-log do not list one-line descriptions from the
103 actual commits being merged.
105 include::signoff-option.txt[]
110 Show a diffstat at the end of the merge. The diffstat is also
111 controlled by the configuration option merge.stat.
113 With -n or --no-stat do not show a diffstat at the end of the
118 Produce the working tree and index state as if a real merge
119 happened (except for the merge information), but do not actually
120 make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
121 (to cause the next `git commit` command to create a merge
122 commit). This allows you to create a single commit on top of
123 the current branch whose effect is the same as merging another
124 branch (or more in case of an octopus).
126 With --no-squash perform the merge and commit the result. This
127 option can be used to override --squash.
129 With --squash, --commit is not allowed, and will fail.
132 Only useful when merging.
136 This option bypasses the pre-merge and commit-msg hooks.
137 See also linkgit:githooks[5].
139 Only useful when merging.
143 --strategy=<strategy>::
144 Use the given merge strategy; can be supplied more than
145 once to specify them in the order they should be tried.
146 If there is no `-s` option, a built-in list of strategies
147 is used instead (`recursive` when merging a single head,
148 `octopus` otherwise).
151 --strategy-option=<option>::
152 Pass merge strategy specific option through to the merge
155 --verify-signatures::
156 --no-verify-signatures::
157 Verify that the tip commit of the side branch being merged is
158 signed with a valid key, i.e. a key that has a valid uid: in the
159 default trust model, this means the signing key has been signed by
160 a trusted key. If the tip commit of the side branch is not signed
161 with a valid key, the merge is aborted.
164 Only useful when merging.
169 Synonyms to --stat and --no-stat; these are deprecated and will be
170 removed in the future.
175 Operate quietly. Implies --no-progress.
183 Turn progress on/off explicitly. If neither is specified,
184 progress is shown if standard error is connected to a terminal.
185 Note that not all merge strategies may support progress
192 Automatically create a temporary stash entry before the operation
193 begins, record it in the special ref `MERGE_AUTOSTASH`
194 and apply it after the operation ends. This means
195 that you can run the operation on a dirty worktree. However, use
196 with care: the final stash application after a successful
197 merge might result in non-trivial conflicts.
199 --allow-unrelated-histories::
200 By default, `git merge` command refuses to merge histories
201 that do not share a common ancestor. This option can be
202 used to override this safety when merging histories of two
203 projects that started their lives independently. As that is
204 a very rare occasion, no configuration variable to enable
205 this by default exists and will not be added.
208 Only useful when merging.