From: Dave Borowitz <dborowitz@google.com>
Date: Thu, 3 Nov 2011 19:43:03 +0000 (-0700)
Subject: Clarify the docstring of DfsBlockCache.reconfigure()
X-Git-Tag: v1.2.0.201112221803-r~48^2~6
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=5a38e5b440d884d95d503c34fa5b81a7a0e41be8;p=jgit.git

Clarify the docstring of DfsBlockCache.reconfigure()

The docstring was copied from the local filesystem cache code, which
actually attempted to reconfigure the cache on the fly. The DFS cache is
designed to be "reconfigured" exactly once.

Change-Id: Ia0b01f5d6b6b3d3a68d65a5c229ff67c1cede5bc
---

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsBlockCache.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsBlockCache.java
index 6379b70a9a..3ae9690d73 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsBlockCache.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsBlockCache.java
@@ -99,9 +99,8 @@ public final class DfsBlockCache {
 	/**
 	 * Modify the configuration of the window cache.
 	 * <p>
-	 * The new configuration is applied immediately. If the new limits are
-	 * smaller than what what is currently cached, older entries will be purged
-	 * as soon as possible to allow the cache to meet the new limit.
+	 * The new configuration is applied immediately, and the existing cache is
+	 * cleared.
 	 *
 	 * @param cfg
 	 *            the new window cache configuration.