Merge branch 'vv/merge-squash-with-explicit-commit' into maint

[thirdparty/git.git] / Documentation / merge-options.txt

diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index a147d436ed38dfbc8154df63b39a25e7be59bac9..79a00d2a4abd6f7191f2639185e199fa85f6289b 100644 (file)
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -3,9 +3,14 @@
        Perform the merge and commit the result. This option can
        be used to override --no-commit.
 +
-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.
+With --no-commit perform the merge and stop just before creating
+a merge commit, to give the user a chance to inspect and further
+tweak the merge result before committing.
++
+Note that fast-forward updates do not create a merge commit and
+therefore there is no way to stop those merges with --no-commit.
+Thus, if you want to ensure your branch is not changed or updated
+by the merge command, use --no-ff with --no-commit.
 
 --edit::
 -e::
@@ -27,6 +32,13 @@ 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.
 
+--cleanup=<mode>::
+       This option determines how the merge message will be cleaned up before
+       commiting. See linkgit:git-commit[1] for more details. In addition, if
+       the '<mode>' is given a value of `scissors`, scissors will be appended
+       to `MERGE_MSG` before being passed on to the commit machinery in the
+       case of a merge conflict.
+
 --ff::
        When the merge resolves as a fast-forward, only update the branch
        pointer, without creating a merge commit.  This is the default