summaryrefslogtreecommitdiff
path: root/Documentation/merge-options.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/merge-options.txt')
-rw-r--r--Documentation/merge-options.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index b613d4ed08..f2f1d0f51c 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -7,6 +7,22 @@ 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 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::
Do not generate a merge commit if the merge resolved as