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 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.
  14
  15 --edit::
  16 -e::
  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
  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[]
  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.
  34
  35 --cleanup=<mode>::
  36         This option determines how the merge message will be cleaned up before
  37         committing. See linkgit:git-commit[1] for more details. In addition, if
  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
  42 --ff::
  43 --no-ff::
  44 --ff-only::
  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.
  61
  62 -S[<keyid>]::
  63 --gpg-sign[=<keyid>]::
  64 --no-gpg-sign::
  65         GPG-sign the resulting merge commit. The `keyid` argument is
  66         optional and defaults to the committer identity; if specified,
  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`.
  70
  71 --log[=<n>]::
  72 --no-log::
  73         In addition to branch names, populate the log message with
  74         one-line descriptions from at most <n> actual commits that are being
  75         merged. See also linkgit:git-fmt-merge-msg[1].
  76 +
  77 With --no-log do not list one-line descriptions from the
  78 actual commits being merged.
  79
  80 include::signoff-option.txt[]
  81
  82 --stat::
  83 -n::
  84 --no-stat::
  85         Show a diffstat at the end of the merge. The diffstat is also
  86         controlled by the configuration option merge.stat.
  87 +
  88 With -n or --no-stat do not show a diffstat at the end of the
  89 merge.
  90
  91 --squash::
  92 --no-squash::
  93         Produce the working tree and index state as if a real merge
  94         happened (except for the merge information), but do not actually
  95         make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
  96         (to cause the next `git commit` command to create a merge
  97         commit).  This allows you to create a single commit on top of
  98         the current branch whose effect is the same as merging another
  99         branch (or more in case of an octopus).
 100 +
 101 With --no-squash perform the merge and commit the result. This
 102 option can be used to override --squash.
 103 +
 104 With --squash, --commit is not allowed, and will fail.
 105
 106 --no-verify::
 107         This option bypasses the pre-merge and commit-msg hooks.
 108         See also linkgit:githooks[5].
 109
 110 -s <strategy>::
 111 --strategy=<strategy>::
 112         Use the given merge strategy; can be supplied more than
 113         once to specify them in the order they should be tried.
 114         If there is no `-s` option, a built-in list of strategies
 115         is used instead ('git merge-recursive' when merging a single
 116         head, 'git merge-octopus' otherwise).
 117
 118 -X <option>::
 119 --strategy-option=<option>::
 120         Pass merge strategy specific option through to the merge
 121         strategy.
 122
 123 --verify-signatures::
 124 --no-verify-signatures::
 125         Verify that the tip commit of the side branch being merged is
 126         signed with a valid key, i.e. a key that has a valid uid: in the
 127         default trust model, this means the signing key has been signed by
 128         a trusted key.  If the tip commit of the side branch is not signed
 129         with a valid key, the merge is aborted.
 130
 131 --summary::
 132 --no-summary::
 133         Synonyms to --stat and --no-stat; these are deprecated and will be
 134         removed in the future.
 135
 136 ifndef::git-pull[]
 137 -q::
 138 --quiet::
 139         Operate quietly. Implies --no-progress.
 140
 141 -v::
 142 --verbose::
 143         Be verbose.
 144
 145 --progress::
 146 --no-progress::
 147         Turn progress on/off explicitly. If neither is specified,
 148         progress is shown if standard error is connected to a terminal.
 149         Note that not all merge strategies may support progress
 150         reporting.
 151
 152 endif::git-pull[]
 153
 154 --autostash::
 155 --no-autostash::
 156         Automatically create a temporary stash entry before the operation
 157         begins, and apply it after the operation ends.  This means
 158         that you can run the operation on a dirty worktree.  However, use
 159         with care: the final stash application after a successful
 160         merge might result in non-trivial conflicts.
 161
 162 --allow-unrelated-histories::
 163         By default, `git merge` command refuses to merge histories
 164         that do not share a common ancestor.  This option can be
 165         used to override this safety when merging histories of two
 166         projects that started their lives independently. As that is
 167         a very rare occasion, no configuration variable to enable
 168         this by default exists and will not be added.