refs DWIMmery: use the same rule for both "git fetch" and others
[git] / Documentation / merge-options.txt
1 --commit::
2 --no-commit::
3         Perform the merge and commit the result. This option can
4         be used to override --no-commit.
5 +
6 With --no-commit perform the merge but pretend the merge
7 failed and do not autocommit, to give the user a chance to
8 inspect and further tweak the merge result before committing.
9
10 --edit::
11 -e::
12 +
13         Invoke editor before committing successful merge to further
14         edit the default merge message.
15
16 --ff::
17 --no-ff::
18         Do not generate a merge commit if the merge resolved as
19         a fast-forward, only update the branch pointer. This is
20         the default behavior of git-merge.
21 +
22 With --no-ff Generate a merge commit even if the merge
23 resolved as a fast-forward.
24
25 --log[=<n>]::
26 --no-log::
27         In addition to branch names, populate the log message with
28         one-line descriptions from at most <n> actual commits that are being
29         merged. See also linkgit:git-fmt-merge-msg[1].
30 +
31 With --no-log do not list one-line descriptions from the
32 actual commits being merged.
33
34
35 --stat::
36 -n::
37 --no-stat::
38         Show a diffstat at the end of the merge. The diffstat is also
39         controlled by the configuration option merge.stat.
40 +
41 With -n or --no-stat do not show a diffstat at the end of the
42 merge.
43
44 --squash::
45 --no-squash::
46         Produce the working tree and index state as if a real
47         merge happened (except for the merge information),
48         but do not actually make a commit or
49         move the `HEAD`, nor record `$GIT_DIR/MERGE_HEAD` to
50         cause the next `git commit` command to create a merge
51         commit.  This allows you to create a single commit on
52         top of the current branch whose effect is the same as
53         merging another branch (or more in case of an octopus).
54 +
55 With --no-squash perform the merge and commit the result. This
56 option can be used to override --squash.
57
58 --ff-only::
59         Refuse to merge and exit with a non-zero status unless the
60         current `HEAD` is already up-to-date or the merge can be
61         resolved as a fast-forward.
62
63 -s <strategy>::
64 --strategy=<strategy>::
65         Use the given merge strategy; can be supplied more than
66         once to specify them in the order they should be tried.
67         If there is no `-s` option, a built-in list of strategies
68         is used instead ('git merge-recursive' when merging a single
69         head, 'git merge-octopus' otherwise).
70
71 -X <option>::
72 --strategy-option=<option>::
73         Pass merge strategy specific option through to the merge
74         strategy.
75
76 --summary::
77 --no-summary::
78         Synonyms to --stat and --no-stat; these are deprecated and will be
79         removed in the future.
80
81 ifndef::git-pull[]
82 -q::
83 --quiet::
84         Operate quietly. Implies --no-progress.
85
86 -v::
87 --verbose::
88         Be verbose.
89
90 --progress::
91 --no-progress::
92         Turn progress on/off explicitly. If neither is specified,
93         progress is shown if standard error is connected to a terminal.
94         Note that not all merge strategies may support progress
95         reporting.
96
97 endif::git-pull[]