summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Sawicki <kevin@github.com>2011-08-05 11:02:10 -0700
committerKevin Sawicki <kevin@github.com>2011-08-05 11:02:10 -0700
commit4ae9d47130012f9a1b471e05397253355c25c1ff (patch)
treecccabab5134c5510ed2e373bd0348fd528bc3b4e
parent1067f82f562231cca1a7d75c6f0c2d2ce04c7381 (diff)
downloadjgit-4ae9d47130012f9a1b471e05397253355c25c1ff.tar.gz
jgit-4ae9d47130012f9a1b471e05397253355c25c1ff.zip
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>
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java7
1 files changed, 6 insertions, 1 deletions
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 cfbcbf1b6d..29dd6e90c3 100644
--- 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) {