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