From ee32ca226e9a4aa2ff48bfdd1ba1d2184317c668 Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Thu, 4 Apr 2019 19:59:52 +0900 Subject: [PATCH] LocalDiskRepositoryTestCase: Clarify semantics of repository creation methods Several of the utility methods create a Repository without setting the 'autoClose' flag, which means that the caller is responsible for closing it. Update the Javadoc to explicitly mention this. Change-Id: I2410dd8d230cd4519f756c38b17141d0daa6c314 Signed-off-by: David Pursehouse --- .../jgit/junit/LocalDiskRepositoryTestCase.java | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java index 4b2eadf41..8e999da6b 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java @@ -366,7 +366,9 @@ public static String indexState(Repository repo, int includedOptions) /** * Creates a new empty bare repository. * - * @return the newly created repository, opened for access + * @return the newly created bare repository, opened for access. The + * repository will not be closed in {@link #tearDown()}; the caller + * is responsible for closing it. * @throws IOException * the repository could not be created in the temporary area */ @@ -377,7 +379,9 @@ protected FileRepository createBareRepository() throws IOException { /** * Creates a new empty repository within a new empty working directory. * - * @return the newly created repository, opened for access + * @return the newly created repository, opened for access. The repository + * will not be closed in {@link #tearDown()}; the caller is + * responsible for closing it. * @throws IOException * the repository could not be created in the temporary area */ @@ -391,7 +395,9 @@ protected FileRepository createWorkRepository() throws IOException { * @param bare * true to create a bare repository; false to make a repository * within its working directory - * @return the newly created repository, opened for access + * @return the newly created repository, opened for access. The repository + * will not be closed in {@link #tearDown()}; the caller is + * responsible for closing it. * @throws IOException * the repository could not be created in the temporary area * @since 5.3