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