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 6379b70a9a95af1f45dc955409a1de66a040b519..3ae9690d7388cf83ac88984e9b45015c753e88e2 100644 (file)
--- 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.