motiejus
/
jgit
1
Fork 0
Code Releases Activity

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>
This commit is contained in:
Matthias Sohn 2017-06-15 22:58:29 +02:00
parent caefdf54ee
commit a45b045c73
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
org.eclipse.jgit/src/org/eclipse/jgit/api/MergeCommand.java
View File

@ -53,6 +53,7 @@
import java.util.Locale; import java.util.Locale;
import java.util.Map; import java.util.Map;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.jgit.api.MergeResult.MergeStatus; import org.eclipse.jgit.api.MergeResult.MergeStatus;
import org.eclipse.jgit.api.errors.CheckoutConflictException; import org.eclipse.jgit.api.errors.CheckoutConflictException;
import org.eclipse.jgit.api.errors.ConcurrentRefUpdateException; import org.eclipse.jgit.api.errors.ConcurrentRefUpdateException;
@ -554,12 +555,15 @@ public MergeCommand setSquash(boolean squash) {
* Sets the fast forward mode. * Sets the fast forward mode.
* *
* @param fastForwardMode * @param fastForwardMode
* corresponds to the --ff/--no-ff/--ff-only options. --ff is the * corresponds to the --ff/--no-ff/--ff-only options. If
* default option. * {@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} * @return {@code this}
* @since 2.2 * @since 2.2
*/ */
public MergeCommand setFastForward(FastForwardMode fastForwardMode) { public MergeCommand setFastForward(
@Nullable FastForwardMode fastForwardMode) {
checkCallable(); checkCallable();
this.fastForwardMode = fastForwardMode; this.fastForwardMode = fastForwardMode;
return this; return this;