diff options
| author | David Pursehouse <david.pursehouse@gmail.com> | 2019-04-15 08:19:43 +0900 |
|---|---|---|
| committer | Matthias Sohn <matthias.sohn@sap.com> | 2019-04-29 00:40:46 +0200 |
| commit | 8491a1134e10a1da183630d0f6469d55fb466b00 (patch) | |
| tree | 030e329f0375648b11d70073808e20293f4d91d5 | |
| parent | 18ae69158fd0dee96422d68331377a217e9dab71 (diff) | |
| download | jgit-8491a1134e10a1da183630d0f6469d55fb466b00.tar.gz jgit-8491a1134e10a1da183630d0f6469d55fb466b00.zip | |
SubmoduleWalk#forPath: Clarify that caller must close returned instance
Change-Id: I25e7913a78c23c030a8c568975ee1044a9973517
Signed-off-by: David Pursehouse <david.pursehouse@gmail.com>
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java index ce8995ad8f..e5559dea09 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java @@ -144,7 +144,8 @@ public class SubmoduleWalk implements AutoCloseable { * path and .gitmodules at the root. * @param path * a {@link java.lang.String} object. - * @return generator at given path, null if no submodule at given path + * @return generator at given path. The caller is responsible for calling + * {@link #close()}. Null if no submodule at given path. * @throws java.io.IOException */ public static SubmoduleWalk forPath(Repository repository, @@ -177,7 +178,8 @@ public class SubmoduleWalk implements AutoCloseable { * path and .gitmodules at the root. * @param path * a {@link java.lang.String} object. - * @return generator at given path, null if no submodule at given path + * @return generator at given path. The caller is responsible for calling + * {@link #close()}. Null if no submodule at given path. * @throws java.io.IOException */ public static SubmoduleWalk forPath(Repository repository, |