summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHan-Wen Nienhuys <hanwen@google.com>2017-03-29 13:51:57 +0200
committerHan-Wen Nienhuys <hanwen@google.com>2017-03-29 16:54:29 +0200
commitf32d65759c9afdcbec28eb3051ed9138b8e03271 (patch)
tree3d9d8276cb1ca742a1a9783ad5e2a79f6e41434e
parent6e652846f64a2e4af0b31c96f52bd86f6fc43e7e (diff)
downloadjgit-f32d65759c9afdcbec28eb3051ed9138b8e03271.tar.gz
jgit-f32d65759c9afdcbec28eb3051ed9138b8e03271.zip
Document the intended use of RepoCommand#setURI()
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com> Change-Id: I4a59dd8278b7b0026094692127b7f55e89c10bae
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java11
1 files changed, 8 insertions, 3 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java
index 31dd51b4fc..e105dc063b 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java
@@ -264,7 +264,11 @@ public class RepoCommand extends GitCommand<RevCommit> {
}
/**
- * Set base URI of the pathes inside the XML
+ * Set base URI of the paths inside the XML. This is typically the name of
+ * the directory holding the manifest repository, eg. for
+ * https://android.googlesource.com/platform/manifest, this should be
+ * /platform (if you would run this on android.googlesource.com)
+ * or https://android.googlesource.com/platform elsewhere.
*
* @param uri
* @return this command
@@ -448,9 +452,10 @@ public class RepoCommand extends GitCommand<RevCommit> {
public RevCommit call() throws GitAPIException {
try {
checkCallable();
- if (uri == null || uri.length() == 0)
+ if (uri == null || uri.length() == 0) {
throw new IllegalArgumentException(
- JGitText.get().uriNotConfigured);
+ JGitText.get().uriNotConfigured);
+ }
if (inputStream == null) {
if (manifestPath == null || manifestPath.length() == 0)
throw new IllegalArgumentException(