Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Sohn2015-01-21 23:24:30 +0000
committerMatthias Sohn2015-01-22 16:25:06 +0000
commit83d7ea19889ef5c0aafc04a5622643822d204f35 (patch)
tree021c1038e29c020250c6bad15da1f9354fa83de7
parent3623aa0c54ae9bfd0afd65386d7ec529857bd2f8 (diff)
downloadjgit-83d7ea19889ef5c0aafc04a5622643822d204f35.tar.gz
jgit-83d7ea19889ef5c0aafc04a5622643822d204f35.tar.xz
jgit-83d7ea19889ef5c0aafc04a5622643822d204f35.zip
Document that repo returned by SubmoduleAddCommand needs to be closed
Bug: 448570 Change-Id: I05be0a5b07f8e22f55637b9a3080362978368bcb Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java11
1 files changed, 11 insertions, 0 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java
index 09e4cf0a1b..06c8f414e3 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java
@@ -136,6 +136,17 @@ public class SubmoduleAddCommand extends
return SubmoduleWalk.forIndex(repo).setFilter(filter).next();
}
+ /**
+ * Executes the {@code SubmoduleAddCommand}
+ *
+ * The {@code Repository} instance returned by this command needs to be
+ * closed by the caller to free resources held by the {@code Repository}
+ * instance. It is recommended to call this method as soon as you don't need
+ * a reference to this {@code Repository} instance anymore.
+ *
+ * @return the newly created {@link Repository}
+ * @throws GitAPIException
+ */
public Repository call() throws GitAPIException {
checkCallable();
if (path == null || path.length() == 0)

Back to the top