Improve javadoc for MergeCommand.setFastForward()

- mark parameter to be nullable
- explain that we fallback to value of merge.ff if set to null and to
--ff if also not configured there

Change-Id: Id077763b95195d21543ac637f9939a6d4179e982
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/MergeCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/MergeCommand.java
index b5d9e8a6b6971bf4288a6835c32bc096342cb064..bae54ce7b5c3bbff7106d9728a03ff212f6ad1eb 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/MergeCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/MergeCommand.java
@@ -53,6 +53,7 @@ import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 
+import org.eclipse.jgit.annotations.Nullable;
 import org.eclipse.jgit.api.MergeResult.MergeStatus;
 import org.eclipse.jgit.api.errors.CheckoutConflictException;
 import org.eclipse.jgit.api.errors.ConcurrentRefUpdateException;
@@ -554,12 +555,15 @@ public class MergeCommand extends GitCommand<MergeResult> {
         * Sets the fast forward mode.
         *
         * @param fastForwardMode
-        *            corresponds to the --ff/--no-ff/--ff-only options. --ff is the
-        *            default option.
+        *            corresponds to the --ff/--no-ff/--ff-only options. If
+        *            {@code null} use the value of the {@code merge.ff} option
+        *            configured in git config. If this option is not configured
+        *            --ff is the built-in default.
         * @return {@code this}
         * @since 2.2
         */
-       public MergeCommand setFastForward(FastForwardMode fastForwardMode) {
+       public MergeCommand setFastForward(
+                       @Nullable FastForwardMode fastForwardMode) {
                checkCallable();
                this.fastForwardMode = fastForwardMode;
                return this;