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
  61 --stat::
  62 -n::
  63 --no-stat::
  64         Show a diffstat at the end of the merge. The diffstat is also
  65         controlled by the configuration option merge.stat.
  66 +
  67 With -n or --no-stat do not show a diffstat at the end of the
  68 merge.
  69
  70 --squash::
  71 --no-squash::
  72         Produce the working tree and index state as if a real merge
  73         happened (except for the merge information), but do not actually
  74         make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
  75         (to cause the next `git commit` command to create a merge
  76         commit).  This allows you to create a single commit on top of
  77         the current branch whose effect is the same as merging another
  78         branch (or more in case of an octopus).
  79 +
  80 With --no-squash perform the merge and commit the result. This
  81 option can be used to override --squash.
  82
  83 -s <strategy>::
  84 --strategy=<strategy>::
  85         Use the given merge strategy; can be supplied more than
  86         once to specify them in the order they should be tried.
  87         If there is no `-s` option, a built-in list of strategies
  88         is used instead ('git merge-recursive' when merging a single
  89         head, 'git merge-octopus' otherwise).
  90
  91 -X <option>::
  92 --strategy-option=<option>::
  93         Pass merge strategy specific option through to the merge
  94         strategy.
  95
  96 --verify-signatures::
  97 --no-verify-signatures::
  98         Verify that the tip commit of the side branch being merged is
  99         signed with a valid key, i.e. a key that has a valid uid: in the
 100         default trust model, this means the signing key has been signed by
 101         a trusted key.  If the tip commit of the side branch is not signed
 102         with a valid key, the merge is aborted.
 103
 104 --summary::
 105 --no-summary::
 106         Synonyms to --stat and --no-stat; these are deprecated and will be
 107         removed in the future.
 108
 109 ifndef::git-pull[]
 110 -q::
 111 --quiet::
 112         Operate quietly. Implies --no-progress.
 113
 114 -v::
 115 --verbose::
 116         Be verbose.
 117
 118 --progress::
 119 --no-progress::
 120         Turn progress on/off explicitly. If neither is specified,
 121         progress is shown if standard error is connected to a terminal.
 122         Note that not all merge strategies may support progress
 123         reporting.
 124
 125 endif::git-pull[]
 126
 127 --allow-unrelated-histories::
 128         By default, `git merge` command refuses to merge histories
 129         that do not share a common ancestor.  This option can be
 130         used to override this safety when merging histories of two
 131         projects that started their lives independently. As that is
 132         a very rare occasion, no configuration variable to enable
 133         this by default exists and will not be added.