summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2012-01-31 22:30:42 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2012-01-31 22:30:42 -0800
commitaf6b37fab1a97943c804f4983452c7fde5b0fbbe (patch)
tree8ca886b1a5d0d7032bb5393c14ac82fae2dfcfc3 /Documentation
parentMerge branch 'ar/i18n-no-gettext' (diff)
parentmerge: use editor by default in interactive sessions (diff)
downloadtgif-af6b37fab1a97943c804f4983452c7fde5b0fbbe.tar.xz
Merge branch 'jc/pull-signed-tag'
* jc/pull-signed-tag: merge: use editor by default in interactive sessions Conflicts: Documentation/merge-options.txt
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-merge.txt2
-rw-r--r--Documentation/merge-options.txt17
2 files changed, 15 insertions, 4 deletions
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index e2e6aba17e..3ceefb8a1f 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -9,7 +9,7 @@ git-merge - Join two or more development histories together
SYNOPSIS
--------
[verse]
-'git merge' [-n] [--stat] [--no-commit] [--squash]
+'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
[-s <strategy>] [-X <strategy-option>]
[--[no-]rerere-autoupdate] [-m <msg>] [<commit>...]
'git merge' <msg> HEAD <commit>...
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index 1a5c12e317..f2f1d0f51c 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::