Documentation / merge-options.txton commit doc/read-tree: remove obsolete remark (30221a3)
   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 but pretend the merge
   7failed and do not autocommit, to give the user a chance to
   8inspect 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).
  18ifndef::git-pull[]
  19The `--edit` (or `-e`) option is still useful if you are
  20giving a draft message with the `-m` option from the command line
  21and want to edit it in the editor.
  22endif::git-pull[]
  23+
  24Older scripts may depend on the historical behaviour of not allowing the
  25user to edit the merge log message. They will see an editor opened when
  26they run `git merge`. To make it easier to adjust such scripts to the
  27updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
  28set 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--log[=<n>]::
  46--no-log::
  47        In addition to branch names, populate the log message with
  48        one-line descriptions from at most <n> actual commits that are being
  49        merged. See also linkgit:git-fmt-merge-msg[1].
  50+
  51With --no-log do not list one-line descriptions from the
  52actual commits being merged.
  53
  54
  55--stat::
  56-n::
  57--no-stat::
  58        Show a diffstat at the end of the merge. The diffstat is also
  59        controlled by the configuration option merge.stat.
  60+
  61With -n or --no-stat do not show a diffstat at the end of the
  62merge.
  63
  64--squash::
  65--no-squash::
  66        Produce the working tree and index state as if a real merge
  67        happened (except for the merge information), but do not actually
  68        make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
  69        (to cause the next `git commit` command to create a merge
  70        commit).  This allows you to create a single commit on top of
  71        the current branch whose effect is the same as merging another
  72        branch (or more in case of an octopus).
  73+
  74With --no-squash perform the merge and commit the result. This
  75option can be used to override --squash.
  76
  77-s <strategy>::
  78--strategy=<strategy>::
  79        Use the given merge strategy; can be supplied more than
  80        once to specify them in the order they should be tried.
  81        If there is no `-s` option, a built-in list of strategies
  82        is used instead ('git merge-recursive' when merging a single
  83        head, 'git merge-octopus' otherwise).
  84
  85-X <option>::
  86--strategy-option=<option>::
  87        Pass merge strategy specific option through to the merge
  88        strategy.
  89
  90--verify-signatures::
  91--no-verify-signatures::
  92        Verify that the tip commit of the side branch being merged is
  93        signed with a valid key, i.e. a key that has a valid uid: in the
  94        default trust model, this means the signing key has been signed by
  95        a trusted key.  If the tip commit of the side branch is not signed
  96        with a valid key, the merge is aborted.
  97
  98--summary::
  99--no-summary::
 100        Synonyms to --stat and --no-stat; these are deprecated and will be
 101        removed in the future.
 102
 103ifndef::git-pull[]
 104-q::
 105--quiet::
 106        Operate quietly. Implies --no-progress.
 107
 108-v::
 109--verbose::
 110        Be verbose.
 111
 112--progress::
 113--no-progress::
 114        Turn progress on/off explicitly. If neither is specified,
 115        progress is shown if standard error is connected to a terminal.
 116        Note that not all merge strategies may support progress
 117        reporting.
 118
 119endif::git-pull[]
 120
 121--allow-unrelated-histories::
 122        By default, `git merge` command refuses to merge histories
 123        that do not share a common ancestor.  This option can be
 124        used to override this safety when merging histories of two
 125        projects that started their lives independently. As that is
 126        a very rare occasion, no configuration variable to enable
 127        this by default exists and will not be added.