merge: cleanup messages like commit
[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+
1ede45e4
EN
6With --no-commit perform the merge and stop just before creating
7a merge commit, to give the user a chance to inspect and further
8tweak the merge result before committing.
9+
10Note that fast-forward updates do not create a merge commit and
11therefore there is no way to stop those merges with --no-commit.
12Thus, if you want to ensure your branch is not changed or updated
13by the merge command, use --no-ff with --no-commit.
93d69d86 14
66f4b98a 15--edit::
66fa1b2c 16-e::
f8246281
JH
17--no-edit::
18 Invoke an editor before committing successful mechanical merge to
19 further edit the auto-generated merge message, so that the user
20 can explain and justify the merge. The `--no-edit` option can be
21 used to accept the auto-generated message (this is generally
08f19cfe
JH
22 discouraged).
23ifndef::git-pull[]
24The `--edit` (or `-e`) option is still useful if you are
25giving a draft message with the `-m` option from the command line
26and want to edit it in the editor.
27endif::git-pull[]
66f4b98a 28+
f8246281
JH
29Older scripts may depend on the historical behaviour of not allowing the
30user to edit the merge log message. They will see an editor opened when
31they run `git merge`. To make it easier to adjust such scripts to the
32updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
33set to `no` at the beginning of them.
66f4b98a 34
d540b70c
DL
35--cleanup=<mode>::
36 This option determines how the merge message will be cleaned up
37 before commiting. See linkgit:git-commit[1] for more details.
38
7c85d274 39--ff::
690b2975
JH
40 When the merge resolves as a fast-forward, only update the branch
41 pointer, without creating a merge commit. This is the default
42 behavior.
43
7c85d274 44--no-ff::
690b2975 45 Create a merge commit even when the merge resolves as a
77c72780 46 fast-forward. This is the default behaviour when merging an
adcc94a0
JH
47 annotated (and possibly signed) tag that is not stored in
48 its natural place in 'refs/tags/' hierarchy.
690b2975
JH
49
50--ff-only::
51 Refuse to merge and exit with a non-zero status unless the
7560f547 52 current `HEAD` is already up to date or the merge can be
690b2975 53 resolved as a fast-forward.
d8abe148 54
488aa65c
TK
55-S[<keyid>]::
56--gpg-sign[=<keyid>]::
57 GPG-sign the resulting merge commit. The `keyid` argument is
58 optional and defaults to the committer identity; if specified,
59 it must be stuck to the option without a space.
60
96e9420c 61--log[=<n>]::
7c85d274 62--no-log::
efb779f8 63 In addition to branch names, populate the log message with
96e9420c
RR
64 one-line descriptions from at most <n> actual commits that are being
65 merged. See also linkgit:git-fmt-merge-msg[1].
7c85d274
JA
66+
67With --no-log do not list one-line descriptions from the
68actual commits being merged.
efb779f8 69
3a4d2c74
TK
70--signoff::
71--no-signoff::
72 Add Signed-off-by line by the committer at the end of the commit
73 log message. The meaning of a signoff depends on the project,
74 but it typically certifies that committer has
75 the rights to submit this work under the same license and
76 agrees to a Developer Certificate of Origin
77 (see http://developercertificate.org/ for more information).
78+
79With --no-signoff do not add a Signed-off-by line.
93d69d86 80
7c85d274
JA
81--stat::
82-n::
83--no-stat::
84 Show a diffstat at the end of the merge. The diffstat is also
85 controlled by the configuration option merge.stat.
86+
87With -n or --no-stat do not show a diffstat at the end of the
88merge.
d08af0ad 89
7d0c6887 90--squash::
7c85d274 91--no-squash::
a58088ab
JL
92 Produce the working tree and index state as if a real merge
93 happened (except for the merge information), but do not actually
94 make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
95 (to cause the next `git commit` command to create a merge
96 commit). This allows you to create a single commit on top of
97 the current branch whose effect is the same as merging another
98 branch (or more in case of an octopus).
7c85d274
JA
99+
100With --no-squash perform the merge and commit the result. This
101option can be used to override --squash.
d66424c4 102
3240240f
SB
103-s <strategy>::
104--strategy=<strategy>::
93d69d86
JL
105 Use the given merge strategy; can be supplied more than
106 once to specify them in the order they should be tried.
107 If there is no `-s` option, a built-in list of strategies
0b444cdb
TR
108 is used instead ('git merge-recursive' when merging a single
109 head, 'git merge-octopus' otherwise).
7c85d274 110
adda3c3b
MB
111-X <option>::
112--strategy-option=<option>::
113 Pass merge strategy specific option through to the merge
114 strategy.
115
efed0022
SG
116--verify-signatures::
117--no-verify-signatures::
05a5869a
KF
118 Verify that the tip commit of the side branch being merged is
119 signed with a valid key, i.e. a key that has a valid uid: in the
120 default trust model, this means the signing key has been signed by
121 a trusted key. If the tip commit of the side branch is not signed
122 with a valid key, the merge is aborted.
efed0022 123
7c85d274
JA
124--summary::
125--no-summary::
126 Synonyms to --stat and --no-stat; these are deprecated and will be
127 removed in the future.
128
409b8d82 129ifndef::git-pull[]
7c85d274
JA
130-q::
131--quiet::
99bfc669 132 Operate quietly. Implies --no-progress.
7c85d274
JA
133
134-v::
135--verbose::
136 Be verbose.
99bfc669
JK
137
138--progress::
139--no-progress::
140 Turn progress on/off explicitly. If neither is specified,
141 progress is shown if standard error is connected to a terminal.
142 Note that not all merge strategies may support progress
143 reporting.
144
409b8d82 145endif::git-pull[]
09c2cb87
JH
146
147--allow-unrelated-histories::
148 By default, `git merge` command refuses to merge histories
149 that do not share a common ancestor. This option can be
150 used to override this safety when merging histories of two
151 projects that started their lives independently. As that is
152 a very rare occasion, no configuration variable to enable
153 this by default exists and will not be added.