X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fmerge-options.txt;h=f2f1d0f51ceffd4f36a408886cee222a37cf4126;hb=4d9e079e826c9b51b610260564111fa8385f7581;hp=1a5c12e3171ab82f489bcd53657c8a89741a3dab;hpb=2cb1ff9ac35ff043e377f78e36a57422a6846485;p=git.git diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt index 1a5c12e31..f2f1d0f51 100644 --- a/Documentation/merge-options.txt +++ b/Documentation/merge-options.txt @@ -8,9 +8,20 @@ failed and do not autocommit, to give the user a chance to 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:: --no-ff::