Merge branch 'wk/pull-signoff'
[git/git.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 --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
17 discouraged).
18 ifndef::git-pull[]
19 The `--edit` (or `-e`) option is still useful if you are
20 giving a draft message with the `-m` option from the command line
21 and want to edit it in the editor.
22 endif::git-pull[]
23 +
24 Older scripts may depend on the historical behaviour of not allowing the
25 user to edit the merge log message. They will see an editor opened when
26 they run `git merge`. To make it easier to adjust such scripts to the
27 updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
28 set to `no` at the beginning of them.
29
30 --ff::
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
35 --no-ff::
36 Create a merge commit even when the merge resolves as a
37 fast-forward. This is the default behaviour when merging an
38 annotated (and possibly signed) tag.
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.
44
45 -S[<keyid>]::
46 --gpg-sign[=<keyid>]::
47 GPG-sign the resulting merge commit. The `keyid` argument is
48 optional and defaults to the committer identity; if specified,
49 it must be stuck to the option without a space.
50
51 --log[=<n>]::
52 --no-log::
53 In addition to branch names, populate the log message with
54 one-line descriptions from at most <n> actual commits that are being
55 merged. See also linkgit:git-fmt-merge-msg[1].
56 +
57 With --no-log do not list one-line descriptions from the
58 actual commits being merged.
59
60 --signoff::
61 --no-signoff::
62 Add Signed-off-by line by the committer at the end of the commit
63 log message. The meaning of a signoff depends on the project,
64 but it typically certifies that committer has
65 the rights to submit this work under the same license and
66 agrees to a Developer Certificate of Origin
67 (see http://developercertificate.org/ for more information).
68 +
69 With --no-signoff do not add a Signed-off-by line.
70
71 --stat::
72 -n::
73 --no-stat::
74 Show a diffstat at the end of the merge. The diffstat is also
75 controlled by the configuration option merge.stat.
76 +
77 With -n or --no-stat do not show a diffstat at the end of the
78 merge.
79
80 --squash::
81 --no-squash::
82 Produce the working tree and index state as if a real merge
83 happened (except for the merge information), but do not actually
84 make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
85 (to cause the next `git commit` command to create a merge
86 commit). This allows you to create a single commit on top of
87 the current branch whose effect is the same as merging another
88 branch (or more in case of an octopus).
89 +
90 With --no-squash perform the merge and commit the result. This
91 option can be used to override --squash.
92
93 -s <strategy>::
94 --strategy=<strategy>::
95 Use the given merge strategy; can be supplied more than
96 once to specify them in the order they should be tried.
97 If there is no `-s` option, a built-in list of strategies
98 is used instead ('git merge-recursive' when merging a single
99 head, 'git merge-octopus' otherwise).
100
101 -X <option>::
102 --strategy-option=<option>::
103 Pass merge strategy specific option through to the merge
104 strategy.
105
106 --verify-signatures::
107 --no-verify-signatures::
108 Verify that the tip commit of the side branch being merged is
109 signed with a valid key, i.e. a key that has a valid uid: in the
110 default trust model, this means the signing key has been signed by
111 a trusted key. If the tip commit of the side branch is not signed
112 with a valid key, the merge is aborted.
113
114 --summary::
115 --no-summary::
116 Synonyms to --stat and --no-stat; these are deprecated and will be
117 removed in the future.
118
119 ifndef::git-pull[]
120 -q::
121 --quiet::
122 Operate quietly. Implies --no-progress.
123
124 -v::
125 --verbose::
126 Be verbose.
127
128 --progress::
129 --no-progress::
130 Turn progress on/off explicitly. If neither is specified,
131 progress is shown if standard error is connected to a terminal.
132 Note that not all merge strategies may support progress
133 reporting.
134
135 endif::git-pull[]
136
137 --allow-unrelated-histories::
138 By default, `git merge` command refuses to merge histories
139 that do not share a common ancestor. This option can be
140 used to override this safety when merging histories of two
141 projects that started their lives independently. As that is
142 a very rare occasion, no configuration variable to enable
143 this by default exists and will not be added.