motiejus
/
jgit
1
Fork 0
Code Releases Activity

Merge changes I05be0a5b,Ieee334f4 

* changes:
  Document that repo returned by SubmoduleAddCommand needs to be closed
  Document that Git instance returned by CloneCommand needs to be closed
This commit is contained in:
Christian Halstrick 2015-01-23 02:54:33 -05:00 committed by Gerrit Code Review @ Eclipse.org
parent 9ffe6deced 83d7ea1988
commit 8f8724c857
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
View File

@ -114,6 +114,12 @@ public CloneCommand() {
/**
* Executes the {@code Clone} command.
*
* The Git instance returned by this command needs to be closed by the
* caller to free resources held by the underlying {@link Repository}
* instance. It is recommended to call this method as soon as you don't need
* a reference to this {@link Git} instance and the underlying
* {@link Repository} instance anymore.
*
* @return the newly created {@code Git} object with associated repository
* @throws InvalidRemoteException
* @throws org.eclipse.jgit.api.errors.TransportException

11
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java
View File

@ -136,6 +136,17 @@ protected boolean submoduleExists() throws IOException {
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)