Git 2.8
[git/git.git] / Documentation / merge-options.txt
CommitLineData
7c85d274
JA
1--commit::
2--no-commit::
3 Perform the merge and commit the result. This option can
4 be used to override --no-commit.
5+
6With --no-commit perform the merge but pretend the merge
7failed and do not autocommit, to give the user a chance to
8inspect and further tweak the merge result before committing.
93d69d86 9
66f4b98a 10--edit::
66fa1b2c 11-e::
f8246281
JH
12--no-edit::
13 Invoke an editor before committing successful mechanical merge to
14 further edit the auto-generated merge message, so that the user
15 can explain and justify the merge. The `--no-edit` option can be
16 used to accept the auto-generated message (this is generally
08f19cfe
JH
17 discouraged).
18ifndef::git-pull[]
19The `--edit` (or `-e`) option is still useful if you are
20giving a draft message with the `-m` option from the command line
21and want to edit it in the editor.
22endif::git-pull[]
66f4b98a 23+
f8246281
JH
24Older scripts may depend on the historical behaviour of not allowing the
25user to edit the merge log message. They will see an editor opened when
26they run `git merge`. To make it easier to adjust such scripts to the
27updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
28set to `no` at the beginning of them.
66f4b98a 29
7c85d274 30--ff::
690b2975
JH
31 When the merge resolves as a fast-forward, only update the branch
32 pointer, without creating a merge commit. This is the default
33 behavior.
34
7c85d274 35--no-ff::
690b2975 36 Create a merge commit even when the merge resolves as a
77c72780
JH
37 fast-forward. This is the default behaviour when merging an
38 annotated (and possibly signed) tag.
690b2975
JH
39
40--ff-only::
41 Refuse to merge and exit with a non-zero status unless the
42 current `HEAD` is already up-to-date or the merge can be
43 resolved as a fast-forward.
d8abe148 44
96e9420c 45--log[=<n>]::
7c85d274 46--no-log::
efb779f8 47 In addition to branch names, populate the log message with
96e9420c
RR
48 one-line descriptions from at most <n> actual commits that are being
49 merged. See also linkgit:git-fmt-merge-msg[1].
7c85d274
JA
50+
51With --no-log do not list one-line descriptions from the
52actual commits being merged.
efb779f8 53
93d69d86 54
7c85d274
JA
55--stat::
56-n::
57--no-stat::
58 Show a diffstat at the end of the merge. The diffstat is also
59 controlled by the configuration option merge.stat.
60+
61With -n or --no-stat do not show a diffstat at the end of the
62merge.
d08af0ad 63
7d0c6887 64--squash::
7c85d274 65--no-squash::
a58088ab
JL
66 Produce the working tree and index state as if a real merge
67 happened (except for the merge information), but do not actually
68 make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
69 (to cause the next `git commit` command to create a merge
70 commit). This allows you to create a single commit on top of
71 the current branch whose effect is the same as merging another
72 branch (or more in case of an octopus).
7c85d274
JA
73+
74With --no-squash perform the merge and commit the result. This
75option can be used to override --squash.
d66424c4 76
3240240f
SB
77-s <strategy>::
78--strategy=<strategy>::
93d69d86
JL
79 Use the given merge strategy; can be supplied more than
80 once to specify them in the order they should be tried.
81 If there is no `-s` option, a built-in list of strategies
0b444cdb
TR
82 is used instead ('git merge-recursive' when merging a single
83 head, 'git merge-octopus' otherwise).
7c85d274 84
adda3c3b
MB
85-X <option>::
86--strategy-option=<option>::
87 Pass merge strategy specific option through to the merge
88 strategy.
89
efed0022
SG
90--verify-signatures::
91--no-verify-signatures::
eb307ae7
SG
92 Verify that the commits being merged have good and trusted GPG signatures
93 and abort the merge in case they do not.
efed0022 94
7c85d274
JA
95--summary::
96--no-summary::
97 Synonyms to --stat and --no-stat; these are deprecated and will be
98 removed in the future.
99
409b8d82 100ifndef::git-pull[]
7c85d274
JA
101-q::
102--quiet::
99bfc669 103 Operate quietly. Implies --no-progress.
7c85d274
JA
104
105-v::
106--verbose::
107 Be verbose.
99bfc669
JK
108
109--progress::
110--no-progress::
111 Turn progress on/off explicitly. If neither is specified,
112 progress is shown if standard error is connected to a terminal.
113 Note that not all merge strategies may support progress
114 reporting.
115
409b8d82 116endif::git-pull[]