From 3623aa0c54ae9bfd0afd65386d7ec529857bd2f8 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Thu, 22 Jan 2015 00:23:13 +0100 Subject: [PATCH] Document that Git instance returned by CloneCommand needs to be closed Bug: 448570 Change-Id: Ieee334f4d82cd71ba98b26abb8667e8f64cac665 Signed-off-by: Matthias Sohn --- org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java index de24dadff..f058f799d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java @@ -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