From 8491a1134e10a1da183630d0f6469d55fb466b00 Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Mon, 15 Apr 2019 08:19:43 +0900 Subject: [PATCH] SubmoduleWalk#forPath: Clarify that caller must close returned instance Change-Id: I25e7913a78c23c030a8c568975ee1044a9973517 Signed-off-by: David Pursehouse --- .../src/org/eclipse/jgit/submodule/SubmoduleWalk.java | 6 ++++-- 1 file 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 ce8995ad8..e5559dea0 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,