Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 1 | --commit:: |
| 2 | --no-commit:: |
| 3 | Perform the merge and commit the result. This option can |
| 4 | be used to override --no-commit. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 5 | ifdef::git-pull[] |
| 6 | Only useful when merging. |
| 7 | endif::git-pull[] |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 8 | + |
Elijah Newren | 1ede45e | 2019-02-21 09:50:29 -0800 | [diff] [blame] | 9 | With --no-commit perform the merge and stop just before creating |
| 10 | a merge commit, to give the user a chance to inspect and further |
| 11 | tweak the merge result before committing. |
| 12 | + |
| 13 | Note that fast-forward updates do not create a merge commit and |
| 14 | therefore there is no way to stop those merges with --no-commit. |
| 15 | Thus, if you want to ensure your branch is not changed or updated |
| 16 | by the merge command, use --no-ff with --no-commit. |
Tuncer Ayaz | 7f87aff | 2008-11-15 01:14:24 +0100 | [diff] [blame] | 17 | |
Jay Soffian | 66f4b98 | 2011-10-08 14:39:52 -0400 | [diff] [blame] | 18 | --edit:: |
Richard Hansen | 66fa1b2 | 2013-05-16 18:26:00 -0400 | [diff] [blame] | 19 | -e:: |
Junio C Hamano | f824628 | 2012-01-10 22:44:45 -0800 | [diff] [blame] | 20 | --no-edit:: |
| 21 | Invoke an editor before committing successful mechanical merge to |
| 22 | further edit the auto-generated merge message, so that the user |
| 23 | can explain and justify the merge. The `--no-edit` option can be |
| 24 | used to accept the auto-generated message (this is generally |
Junio C Hamano | 08f19cf | 2014-01-14 10:26:21 -0800 | [diff] [blame] | 25 | discouraged). |
| 26 | ifndef::git-pull[] |
| 27 | The `--edit` (or `-e`) option is still useful if you are |
| 28 | giving a draft message with the `-m` option from the command line |
| 29 | and want to edit it in the editor. |
| 30 | endif::git-pull[] |
Jay Soffian | 66f4b98 | 2011-10-08 14:39:52 -0400 | [diff] [blame] | 31 | + |
Junio C Hamano | f824628 | 2012-01-10 22:44:45 -0800 | [diff] [blame] | 32 | Older scripts may depend on the historical behaviour of not allowing the |
| 33 | user to edit the merge log message. They will see an editor opened when |
| 34 | they run `git merge`. To make it easier to adjust such scripts to the |
| 35 | updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be |
| 36 | set to `no` at the beginning of them. |
Jay Soffian | 66f4b98 | 2011-10-08 14:39:52 -0400 | [diff] [blame] | 37 | |
Denton Liu | d540b70 | 2019-04-17 11:23:27 +0100 | [diff] [blame] | 38 | --cleanup=<mode>:: |
Denton Liu | 1055997 | 2019-04-17 11:23:28 +0100 | [diff] [blame] | 39 | This option determines how the merge message will be cleaned up before |
Elijah Newren | 031fd4b | 2019-11-05 17:07:20 +0000 | [diff] [blame] | 40 | committing. See linkgit:git-commit[1] for more details. In addition, if |
Denton Liu | 1055997 | 2019-04-17 11:23:28 +0100 | [diff] [blame] | 41 | the '<mode>' is given a value of `scissors`, scissors will be appended |
| 42 | to `MERGE_MSG` before being passed on to the commit machinery in the |
| 43 | case of a merge conflict. |
Denton Liu | d540b70 | 2019-04-17 11:23:27 +0100 | [diff] [blame] | 44 | |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 45 | ifdef::git-merge[] |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 46 | --ff:: |
| 47 | --no-ff:: |
Junio C Hamano | 690b297 | 2012-02-22 14:27:07 -0800 | [diff] [blame] | 48 | --ff-only:: |
Elijah Newren | 27fd1e4 | 2019-08-30 17:23:13 -0700 | [diff] [blame] | 49 | Specifies how a merge is handled when the merged-in history is |
| 50 | already a descendant of the current history. `--ff` is the |
| 51 | default unless merging an annotated (and possibly signed) tag |
| 52 | that is not stored in its natural place in the `refs/tags/` |
| 53 | hierarchy, in which case `--no-ff` is assumed. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 54 | endif::git-merge[] |
| 55 | ifdef::git-pull[] |
| 56 | --ff-only:: |
| 57 | Only update to the new history if there is no divergent local |
| 58 | history. This is the default when no method for reconciling |
| 59 | divergent histories is provided (via the --rebase=* flags). |
| 60 | |
| 61 | --ff:: |
| 62 | --no-ff:: |
| 63 | When merging rather than rebasing, specifies how a merge is |
| 64 | handled when the merged-in history is already a descendant of |
| 65 | the current history. If merging is requested, `--ff` is the |
| 66 | default unless merging an annotated (and possibly signed) tag |
| 67 | that is not stored in its natural place in the `refs/tags/` |
| 68 | hierarchy, in which case `--no-ff` is assumed. |
| 69 | endif::git-pull[] |
Elijah Newren | 27fd1e4 | 2019-08-30 17:23:13 -0700 | [diff] [blame] | 70 | + |
| 71 | With `--ff`, when possible resolve the merge as a fast-forward (only |
| 72 | update the branch pointer to match the merged branch; do not create a |
| 73 | merge commit). When not possible (when the merged-in history is not a |
| 74 | descendant of the current history), create a merge commit. |
| 75 | + |
| 76 | With `--no-ff`, create a merge commit in all cases, even when the merge |
| 77 | could instead be resolved as a fast-forward. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 78 | ifdef::git-merge[] |
Elijah Newren | 27fd1e4 | 2019-08-30 17:23:13 -0700 | [diff] [blame] | 79 | + |
| 80 | With `--ff-only`, resolve the merge as a fast-forward when possible. |
| 81 | When not possible, refuse to merge and exit with a non-zero status. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 82 | endif::git-merge[] |
SZEDER Gábor | d8abe14 | 2008-04-06 03:23:43 +0200 | [diff] [blame] | 83 | |
W. Trevor King | 488aa65 | 2017-10-12 02:02:17 -0700 | [diff] [blame] | 84 | -S[<keyid>]:: |
| 85 | --gpg-sign[=<keyid>]:: |
Đoàn Trần Công Danh | 5c5bac1 | 2020-04-03 17:28:07 +0700 | [diff] [blame] | 86 | --no-gpg-sign:: |
W. Trevor King | 488aa65 | 2017-10-12 02:02:17 -0700 | [diff] [blame] | 87 | GPG-sign the resulting merge commit. The `keyid` argument is |
| 88 | optional and defaults to the committer identity; if specified, |
Đoàn Trần Công Danh | 5c5bac1 | 2020-04-03 17:28:07 +0700 | [diff] [blame] | 89 | it must be stuck to the option without a space. `--no-gpg-sign` |
| 90 | is useful to countermand both `commit.gpgSign` configuration variable, |
| 91 | and earlier `--gpg-sign`. |
W. Trevor King | 488aa65 | 2017-10-12 02:02:17 -0700 | [diff] [blame] | 92 | |
Ramkumar Ramachandra | 96e9420 | 2010-09-08 23:29:54 +0530 | [diff] [blame] | 93 | --log[=<n>]:: |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 94 | --no-log:: |
SZEDER Gábor | efb779f | 2008-04-06 03:23:46 +0200 | [diff] [blame] | 95 | In addition to branch names, populate the log message with |
Ramkumar Ramachandra | 96e9420 | 2010-09-08 23:29:54 +0530 | [diff] [blame] | 96 | one-line descriptions from at most <n> actual commits that are being |
| 97 | merged. See also linkgit:git-fmt-merge-msg[1]. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 98 | ifdef::git-pull[] |
| 99 | Only useful when merging. |
| 100 | endif::git-pull[] |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 101 | + |
| 102 | With --no-log do not list one-line descriptions from the |
| 103 | actual commits being merged. |
SZEDER Gábor | efb779f | 2008-04-06 03:23:46 +0200 | [diff] [blame] | 104 | |
Junio C Hamano | ae2e0ab | 2020-10-19 18:03:52 -0700 | [diff] [blame] | 105 | include::signoff-option.txt[] |
SZEDER Gábor | efb779f | 2008-04-06 03:23:46 +0200 | [diff] [blame] | 106 | |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 107 | --stat:: |
| 108 | -n:: |
| 109 | --no-stat:: |
| 110 | Show a diffstat at the end of the merge. The diffstat is also |
| 111 | controlled by the configuration option merge.stat. |
| 112 | + |
| 113 | With -n or --no-stat do not show a diffstat at the end of the |
| 114 | merge. |
Lars Hjemli | d08af0a | 2007-09-24 00:51:44 +0200 | [diff] [blame] | 115 | |
Junio C Hamano | 7d0c688 | 2006-06-23 01:37:02 -0700 | [diff] [blame] | 116 | --squash:: |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 117 | --no-squash:: |
Justin Lebar | a58088a | 2014-03-31 15:11:44 -0700 | [diff] [blame] | 118 | Produce the working tree and index state as if a real merge |
| 119 | happened (except for the merge information), but do not actually |
| 120 | make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD` |
| 121 | (to cause the next `git commit` command to create a merge |
| 122 | commit). This allows you to create a single commit on top of |
| 123 | the current branch whose effect is the same as merging another |
| 124 | branch (or more in case of an octopus). |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 125 | + |
| 126 | With --no-squash perform the merge and commit the result. This |
| 127 | option can be used to override --squash. |
Vishal Verma | 1d14d0c | 2019-05-24 12:36:17 -0600 | [diff] [blame] | 128 | + |
| 129 | With --squash, --commit is not allowed, and will fail. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 130 | ifdef::git-pull[] |
| 131 | + |
| 132 | Only useful when merging. |
| 133 | endif::git-pull[] |
Lars Hjemli | d66424c | 2007-09-24 00:51:45 +0200 | [diff] [blame] | 134 | |
Alex Riesen | fa21296 | 2021-10-29 15:45:45 +0200 | [diff] [blame] | 135 | --[no-]verify:: |
| 136 | By default, the pre-merge and commit-msg hooks are run. |
| 137 | When `--no-verify` is given, these are bypassed. |
Michael J Gruber | a1f3dd7 | 2019-08-07 11:57:06 -0700 | [diff] [blame] | 138 | See also linkgit:githooks[5]. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 139 | ifdef::git-pull[] |
| 140 | Only useful when merging. |
| 141 | endif::git-pull[] |
Michael J Gruber | a1f3dd7 | 2019-08-07 11:57:06 -0700 | [diff] [blame] | 142 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 143 | -s <strategy>:: |
| 144 | --strategy=<strategy>:: |
Jon Loeliger | 93d69d8 | 2005-11-06 23:30:56 -0600 | [diff] [blame] | 145 | Use the given merge strategy; can be supplied more than |
| 146 | once to specify them in the order they should be tried. |
| 147 | If there is no `-s` option, a built-in list of strategies |
Elijah Newren | f5a3c5e | 2021-08-04 05:38:02 +0000 | [diff] [blame] | 148 | is used instead (`ort` when merging a single head, |
Elijah Newren | e80178e | 2021-08-04 23:50:47 +0000 | [diff] [blame] | 149 | `octopus` otherwise). |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 150 | |
Marc Branchaud | adda3c3 | 2010-04-12 12:28:13 -0400 | [diff] [blame] | 151 | -X <option>:: |
| 152 | --strategy-option=<option>:: |
| 153 | Pass merge strategy specific option through to the merge |
| 154 | strategy. |
| 155 | |
Sebastian Götte | efed002 | 2013-03-31 18:02:24 +0200 | [diff] [blame] | 156 | --verify-signatures:: |
| 157 | --no-verify-signatures:: |
Keller Fuchs | 05a5869 | 2016-05-13 09:51:01 +0000 | [diff] [blame] | 158 | Verify that the tip commit of the side branch being merged is |
| 159 | signed with a valid key, i.e. a key that has a valid uid: in the |
| 160 | default trust model, this means the signing key has been signed by |
| 161 | a trusted key. If the tip commit of the side branch is not signed |
| 162 | with a valid key, the merge is aborted. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 163 | ifdef::git-pull[] |
| 164 | + |
| 165 | Only useful when merging. |
| 166 | endif::git-pull[] |
Sebastian Götte | efed002 | 2013-03-31 18:02:24 +0200 | [diff] [blame] | 167 | |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 168 | --summary:: |
| 169 | --no-summary:: |
| 170 | Synonyms to --stat and --no-stat; these are deprecated and will be |
| 171 | removed in the future. |
| 172 | |
Tay Ray Chuan | 409b8d8 | 2010-02-24 20:50:21 +0800 | [diff] [blame] | 173 | ifndef::git-pull[] |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 174 | -q:: |
| 175 | --quiet:: |
Jeff King | 99bfc66 | 2011-02-20 04:53:21 -0500 | [diff] [blame] | 176 | Operate quietly. Implies --no-progress. |
Jari Aalto | 7c85d27 | 2009-10-22 22:25:20 +0300 | [diff] [blame] | 177 | |
| 178 | -v:: |
| 179 | --verbose:: |
| 180 | Be verbose. |
Jeff King | 99bfc66 | 2011-02-20 04:53:21 -0500 | [diff] [blame] | 181 | |
| 182 | --progress:: |
| 183 | --no-progress:: |
| 184 | Turn progress on/off explicitly. If neither is specified, |
| 185 | progress is shown if standard error is connected to a terminal. |
| 186 | Note that not all merge strategies may support progress |
| 187 | reporting. |
| 188 | |
Tay Ray Chuan | 409b8d8 | 2010-02-24 20:50:21 +0800 | [diff] [blame] | 189 | endif::git-pull[] |
Junio C Hamano | 09c2cb8 | 2016-03-18 13:21:09 -0700 | [diff] [blame] | 190 | |
Denton Liu | a03b555 | 2020-04-07 10:28:07 -0400 | [diff] [blame] | 191 | --autostash:: |
| 192 | --no-autostash:: |
| 193 | Automatically create a temporary stash entry before the operation |
Philippe Blain | fd441eb | 2021-07-23 12:14:28 +0000 | [diff] [blame] | 194 | begins, record it in the special ref `MERGE_AUTOSTASH` |
| 195 | and apply it after the operation ends. This means |
Denton Liu | a03b555 | 2020-04-07 10:28:07 -0400 | [diff] [blame] | 196 | that you can run the operation on a dirty worktree. However, use |
| 197 | with care: the final stash application after a successful |
| 198 | merge might result in non-trivial conflicts. |
| 199 | |
Junio C Hamano | 09c2cb8 | 2016-03-18 13:21:09 -0700 | [diff] [blame] | 200 | --allow-unrelated-histories:: |
| 201 | By default, `git merge` command refuses to merge histories |
| 202 | that do not share a common ancestor. This option can be |
| 203 | used to override this safety when merging histories of two |
| 204 | projects that started their lives independently. As that is |
| 205 | a very rare occasion, no configuration variable to enable |
| 206 | this by default exists and will not be added. |
Elijah Newren | 359ff69 | 2021-07-22 05:04:49 +0000 | [diff] [blame] | 207 | ifdef::git-pull[] |
| 208 | + |
| 209 | Only useful when merging. |
| 210 | endif::git-pull[] |