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