Browse Source

SubmoduleWalk#forPath: Clarify that caller must close returned instance

Change-Id: I25e7913a78c23c030a8c568975ee1044a9973517
Signed-off-by: David Pursehouse <david.pursehouse@gmail.com>
stable-5.4
David Pursehouse 6 years ago committed by Matthias Sohn
parent
commit
8491a1134e
  1. 6
      org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java

6
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. * path and .gitmodules at the root.
* @param path * @param path
* a {@link java.lang.String} object. * 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 * @throws java.io.IOException
*/ */
public static SubmoduleWalk forPath(Repository repository, public static SubmoduleWalk forPath(Repository repository,
@ -177,7 +178,8 @@ public class SubmoduleWalk implements AutoCloseable {
* path and .gitmodules at the root. * path and .gitmodules at the root.
* @param path * @param path
* a {@link java.lang.String} object. * 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 * @throws java.io.IOException
*/ */
public static SubmoduleWalk forPath(Repository repository, public static SubmoduleWalk forPath(Repository repository,

Loading…
Cancel
Save