Correct comment on CloneCommand.setRemote method.

The previous comment stated that the value set was used
to keep track of the branch in the remote repository
which was incorrect.

Updated the method comment to match the format used
for the PushCommand.setRemote and FetchCommand.setRemote
methods.

Change-Id: I11b81eb3125958af29247b485da56fd88c3bfdf5
Signed-off-by: Kevin Sawicki <kevin@github.com>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
index cfbcbf1b6d2bc61c03a5dfadd245e2ef927ee358..29dd6e90c3427ee605d648c6cb59ff8d7c960eef 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
@@ -301,8 +301,13 @@ public class CloneCommand implements Callable<Git> {
        }
 
        /**
+        * The remote name used to keep track of the upstream repository for the
+        * clone operation. If no remote name is set, the default value of
+        * <code>Constants.DEFAULT_REMOTE_NAME</code> will be used.
+        *
+        * @see Constants#DEFAULT_REMOTE_NAME
         * @param remote
-        *            the branch to keep track of in the origin repository
+        *            name that keeps track of the upstream repository
         * @return this instance
         */
        public CloneCommand setRemote(String remote) {