Merge branch 'maint-1.7.8' into maint-1.7.9
[gitweb.git] / Documentation / merge-options.txt
index 3b83dba1a0d8ad1436d15d164783f08593f54357..5afc99f650b17a6ff660d81ba0687f2f46079f7a 100644 (file)
@@ -7,20 +7,40 @@ With --no-commit perform the merge but pretend the merge
 failed and do not autocommit, to give the user a chance to
 inspect and further tweak the merge result before committing.
 
+--edit::
+--no-edit::
+       Invoke editor before committing successful merge to further
+       edit the default merge message. The `--no-edit` option can be
+       used to accept the auto-generated message (this is generally
+       discouraged) when merging an annotated tag, in which case
+       `git merge` automatically spawns the editor so that the result
+       of the GPG verification of the tag can be seen.
++
+Older scripts may depend on the historical behaviour of not allowing the
+user to edit the merge log message. They will see an editor opened when
+they run `git merge` to merge an annotated tag. To make it easier to adjust
+such scripts to the updated behaviour, the environment variable
+`GIT_MERGE_AUTOEDIT` can be set to `no` at the beginning of them.
+
 --ff::
+       When the merge resolves as a fast-forward, only update the branch
+       pointer, without creating a merge commit.  This is the default
+       behavior.
+
 --no-ff::
-       Do not generate a merge commit if the merge resolved as
-       a fast-forward, only update the branch pointer. This is
-       the default behavior of git-merge.
-+
-With --no-ff Generate a merge commit even if the merge
-resolved as a fast-forward.
+       Create a merge commit even when the merge resolves as a
+       fast-forward.
+
+--ff-only::
+       Refuse to merge and exit with a non-zero status unless the
+       current `HEAD` is already up-to-date or the merge can be
+       resolved as a fast-forward.
 
---log::
+--log[=<n>]::
 --no-log::
        In addition to branch names, populate the log message with
-       one-line descriptions from the actual commits that are being
-       merged.
+       one-line descriptions from at most <n> actual commits that are being
+       merged. See also linkgit:git-fmt-merge-msg[1].
 +
 With --no-log do not list one-line descriptions from the
 actual commits being merged.
@@ -49,11 +69,6 @@ merge.
 With --no-squash perform the merge and commit the result. This
 option can be used to override --squash.
 
---ff-only::
-       Refuse to merge and exit with a non-zero status unless the
-       current `HEAD` is already up-to-date or the merge can be
-       resolved as a fast-forward.
-
 -s <strategy>::
 --strategy=<strategy>::
        Use the given merge strategy; can be supplied more than
@@ -62,20 +77,30 @@ option can be used to override --squash.
        is used instead ('git merge-recursive' when merging a single
        head, 'git merge-octopus' otherwise).
 
+-X <option>::
+--strategy-option=<option>::
+       Pass merge strategy specific option through to the merge
+       strategy.
+
 --summary::
 --no-summary::
        Synonyms to --stat and --no-stat; these are deprecated and will be
        removed in the future.
 
+ifndef::git-pull[]
 -q::
 --quiet::
-       Operate quietly.
+       Operate quietly. Implies --no-progress.
 
 -v::
 --verbose::
        Be verbose.
 
--X <option>::
---strategy-option=<option>::
-       Pass merge strategy specific option through to the merge
-       strategy.
+--progress::
+--no-progress::
+       Turn progress on/off explicitly. If neither is specified,
+       progress is shown if standard error is connected to a terminal.
+       Note that not all merge strategies may support progress
+       reporting.
+
+endif::git-pull[]