From: Junio C Hamano Date: Mon, 27 Feb 2012 07:05:42 +0000 (-0800) Subject: Merge branch 'jc/doc-merge-options' X-Git-Tag: v1.7.10-rc0~45 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=5419127d0475a78983696544ca5e672e8ea4075d;p=git.git Merge branch 'jc/doc-merge-options' * jc/doc-merge-options: Documentation/merge-options.txt: group "ff" related options together --- 5419127d0475a78983696544ca5e672e8ea4075d diff --cc Documentation/merge-options.txt index f2f1d0f51,2bd92c474..0bcbe0ac3 --- a/Documentation/merge-options.txt +++ b/Documentation/merge-options.txt @@@ -8,29 -8,23 +8,34 @@@ failed and do not autocommit, to give t inspect and further tweak the merge result before committing. --edit:: --e:: - Invoke editor before committing successful merge to further - edit the default merge message. +--no-edit:: + Invoke an editor before committing successful mechanical merge to + further edit the auto-generated merge message, so that the user + can explain and justify the merge. The `--no-edit` option can be + used to accept the auto-generated message (this is generally + discouraged). The `--edit` option is still useful if you are + giving a draft message with the `-m` option from the command line + and want to edit it in the editor. ++ +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 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[=]:: --no-log::