Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [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. |
| 5 | + |
Junio C Hamano | 11f1537 | 2019-03-07 03:17:00 | [diff] [blame] | 6 | With --no-commit perform the merge and stop just before creating |
| 7 | a merge commit, to give the user a chance to inspect and further |
| 8 | tweak the merge result before committing. |
| 9 | + |
| 10 | Note that fast-forward updates do not create a merge commit and |
| 11 | therefore there is no way to stop those merges with --no-commit. |
| 12 | Thus, if you want to ensure your branch is not changed or updated |
| 13 | by the merge command, use --no-ff with --no-commit. |
Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 14 | |
Junio C Hamano | 11821ed | 2011-10-19 18:42:09 | [diff] [blame] | 15 | --edit:: |
Junio C Hamano | 7e590a1 | 2013-06-02 23:46:52 | [diff] [blame] | 16 | -e:: |
Junio C Hamano | 795a5a3 | 2012-02-02 01:36:37 | [diff] [blame] | 17 | --no-edit:: |
| 18 | Invoke an editor before committing successful mechanical merge to |
| 19 | further edit the auto-generated merge message, so that the user |
| 20 | can explain and justify the merge. The `--no-edit` option can be |
| 21 | used to accept the auto-generated message (this is generally |
Junio C Hamano | c5bd79e | 2014-01-27 21:31:26 | [diff] [blame] | 22 | discouraged). |
| 23 | ifndef::git-pull[] |
| 24 | The `--edit` (or `-e`) option is still useful if you are |
| 25 | giving a draft message with the `-m` option from the command line |
| 26 | and want to edit it in the editor. |
| 27 | endif::git-pull[] |
Junio C Hamano | 795a5a3 | 2012-02-02 01:36:37 | [diff] [blame] | 28 | + |
| 29 | Older scripts may depend on the historical behaviour of not allowing the |
| 30 | user to edit the merge log message. They will see an editor opened when |
| 31 | they run `git merge`. To make it easier to adjust such scripts to the |
| 32 | updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be |
| 33 | set to `no` at the beginning of them. |
Junio C Hamano | 11821ed | 2011-10-19 18:42:09 | [diff] [blame] | 34 | |
Junio C Hamano | d1063b1 | 2019-05-08 17:18:07 | [diff] [blame] | 35 | --cleanup=<mode>:: |
| 36 | This option determines how the merge message will be cleaned up before |
Junio C Hamano | 8ef91f3 | 2019-12-01 22:58:27 | [diff] [blame] | 37 | committing. See linkgit:git-commit[1] for more details. In addition, if |
Junio C Hamano | d1063b1 | 2019-05-08 17:18:07 | [diff] [blame] | 38 | the '<mode>' is given a value of `scissors`, scissors will be appended |
| 39 | to `MERGE_MSG` before being passed on to the commit machinery in the |
| 40 | case of a merge conflict. |
| 41 | |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 42 | --ff:: |
| 43 | --no-ff:: |
Junio C Hamano | f54f08e | 2012-02-27 07:49:19 | [diff] [blame] | 44 | --ff-only:: |
Junio C Hamano | a885831 | 2019-09-30 05:07:45 | [diff] [blame] | 45 | Specifies how a merge is handled when the merged-in history is |
| 46 | already a descendant of the current history. `--ff` is the |
| 47 | default unless merging an annotated (and possibly signed) tag |
| 48 | that is not stored in its natural place in the `refs/tags/` |
| 49 | hierarchy, in which case `--no-ff` is assumed. |
| 50 | + |
| 51 | With `--ff`, when possible resolve the merge as a fast-forward (only |
| 52 | update the branch pointer to match the merged branch; do not create a |
| 53 | merge commit). When not possible (when the merged-in history is not a |
| 54 | descendant of the current history), create a merge commit. |
| 55 | + |
| 56 | With `--no-ff`, create a merge commit in all cases, even when the merge |
| 57 | could instead be resolved as a fast-forward. |
| 58 | + |
| 59 | With `--ff-only`, resolve the merge as a fast-forward when possible. |
| 60 | When not possible, refuse to merge and exit with a non-zero status. |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 61 | |
Junio C Hamano | f7e3f47 | 2017-10-20 06:45:24 | [diff] [blame] | 62 | -S[<keyid>]:: |
| 63 | --gpg-sign[=<keyid>]:: |
Junio C Hamano | 67bf224 | 2020-04-22 21:41:44 | [diff] [blame] | 64 | --no-gpg-sign:: |
Junio C Hamano | f7e3f47 | 2017-10-20 06:45:24 | [diff] [blame] | 65 | GPG-sign the resulting merge commit. The `keyid` argument is |
| 66 | optional and defaults to the committer identity; if specified, |
Junio C Hamano | 67bf224 | 2020-04-22 21:41:44 | [diff] [blame] | 67 | it must be stuck to the option without a space. `--no-gpg-sign` |
| 68 | is useful to countermand both `commit.gpgSign` configuration variable, |
| 69 | and earlier `--gpg-sign`. |
Junio C Hamano | f7e3f47 | 2017-10-20 06:45:24 | [diff] [blame] | 70 | |
Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 71 | --log[=<n>]:: |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 72 | --no-log:: |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 73 | In addition to branch names, populate the log message with |
Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 74 | one-line descriptions from at most <n> actual commits that are being |
| 75 | merged. See also linkgit:git-fmt-merge-msg[1]. |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 76 | + |
| 77 | With --no-log do not list one-line descriptions from the |
| 78 | actual commits being merged. |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 79 | |
Junio C Hamano | 3a9c034 | 2017-11-10 06:01:12 | [diff] [blame] | 80 | --signoff:: |
| 81 | --no-signoff:: |
| 82 | Add Signed-off-by line by the committer at the end of the commit |
| 83 | log message. The meaning of a signoff depends on the project, |
| 84 | but it typically certifies that committer has |
| 85 | the rights to submit this work under the same license and |
| 86 | agrees to a Developer Certificate of Origin |
| 87 | (see http://developercertificate.org/ for more information). |
| 88 | + |
| 89 | With --no-signoff do not add a Signed-off-by line. |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 90 | |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 91 | --stat:: |
| 92 | -n:: |
| 93 | --no-stat:: |
| 94 | Show a diffstat at the end of the merge. The diffstat is also |
| 95 | controlled by the configuration option merge.stat. |
| 96 | + |
| 97 | With -n or --no-stat do not show a diffstat at the end of the |
| 98 | merge. |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 99 | |
Junio C Hamano | 3901ffb | 2006-06-26 23:46:53 | [diff] [blame] | 100 | --squash:: |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 101 | --no-squash:: |
Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 102 | Produce the working tree and index state as if a real merge |
| 103 | happened (except for the merge information), but do not actually |
| 104 | make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD` |
| 105 | (to cause the next `git commit` command to create a merge |
| 106 | commit). This allows you to create a single commit on top of |
| 107 | the current branch whose effect is the same as merging another |
| 108 | branch (or more in case of an octopus). |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 109 | + |
| 110 | With --no-squash perform the merge and commit the result. This |
| 111 | option can be used to override --squash. |
Junio C Hamano | 73c6486 | 2019-06-18 03:24:20 | [diff] [blame] | 112 | + |
| 113 | With --squash, --commit is not allowed, and will fail. |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 114 | |
Junio C Hamano | cb70539 | 2019-09-18 19:30:01 | [diff] [blame] | 115 | --no-verify:: |
| 116 | This option bypasses the pre-merge and commit-msg hooks. |
| 117 | See also linkgit:githooks[5]. |
| 118 | |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 119 | -s <strategy>:: |
| 120 | --strategy=<strategy>:: |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 121 | Use the given merge strategy; can be supplied more than |
| 122 | once to specify them in the order they should be tried. |
| 123 | If there is no `-s` option, a built-in list of strategies |
Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 124 | is used instead ('git merge-recursive' when merging a single |
| 125 | head, 'git merge-octopus' otherwise). |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 126 | |
Junio C Hamano | b04bb3f | 2010-04-14 14:07:36 | [diff] [blame] | 127 | -X <option>:: |
| 128 | --strategy-option=<option>:: |
| 129 | Pass merge strategy specific option through to the merge |
| 130 | strategy. |
| 131 | |
Junio C Hamano | edf80bd | 2013-04-05 22:14:36 | [diff] [blame] | 132 | --verify-signatures:: |
| 133 | --no-verify-signatures:: |
Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 134 | Verify that the tip commit of the side branch being merged is |
| 135 | signed with a valid key, i.e. a key that has a valid uid: in the |
| 136 | default trust model, this means the signing key has been signed by |
| 137 | a trusted key. If the tip commit of the side branch is not signed |
| 138 | with a valid key, the merge is aborted. |
Junio C Hamano | edf80bd | 2013-04-05 22:14:36 | [diff] [blame] | 139 | |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 140 | --summary:: |
| 141 | --no-summary:: |
| 142 | Synonyms to --stat and --no-stat; these are deprecated and will be |
| 143 | removed in the future. |
| 144 | |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 145 | ifndef::git-pull[] |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 146 | -q:: |
| 147 | --quiet:: |
Junio C Hamano | d2c978f | 2011-03-20 19:42:22 | [diff] [blame] | 148 | Operate quietly. Implies --no-progress. |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 149 | |
| 150 | -v:: |
| 151 | --verbose:: |
| 152 | Be verbose. |
Junio C Hamano | d2c978f | 2011-03-20 19:42:22 | [diff] [blame] | 153 | |
| 154 | --progress:: |
| 155 | --no-progress:: |
| 156 | Turn progress on/off explicitly. If neither is specified, |
| 157 | progress is shown if standard error is connected to a terminal. |
| 158 | Note that not all merge strategies may support progress |
| 159 | reporting. |
| 160 | |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 161 | endif::git-pull[] |
Junio C Hamano | 7921e7c | 2016-04-29 21:55:09 | [diff] [blame] | 162 | |
Junio C Hamano | 67cc2b7 | 2020-04-30 00:03:20 | [diff] [blame] | 163 | --autostash:: |
| 164 | --no-autostash:: |
| 165 | Automatically create a temporary stash entry before the operation |
| 166 | begins, and apply it after the operation ends. This means |
| 167 | that you can run the operation on a dirty worktree. However, use |
| 168 | with care: the final stash application after a successful |
| 169 | merge might result in non-trivial conflicts. |
| 170 | |
Junio C Hamano | 7921e7c | 2016-04-29 21:55:09 | [diff] [blame] | 171 | --allow-unrelated-histories:: |
| 172 | By default, `git merge` command refuses to merge histories |
| 173 | that do not share a common ancestor. This option can be |
| 174 | used to override this safety when merging histories of two |
| 175 | projects that started their lives independently. As that is |
| 176 | a very rare occasion, no configuration variable to enable |
| 177 | this by default exists and will not be added. |