svn commit: r527946 - /lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java

[gs...@apache.org]

Author: gsingers
Date: Thu Apr 12 07:02:09 2007
New Revision: 527946

URL: http://svn.apache.org/viewvc?view=rev&rev=527946
Log:
http://www.gossamer-threads.com/lists/lucene/java-dev/47895

Added javadocs about when to call optimize() method.

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java?view=diff&rev=527946&r1=527945&r2=527946
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java Thu Apr 12 07:02:09 2007
@@ -1119,7 +1119,13 @@
 
   /** Merges all segments together into a single segment,
    * optimizing an index for search.
+   *
+   * <p>It is recommended that this method be called upon completion of indexing.  In
+   * environments with frequent updates, optimize is best done during low volume times, if at all. 
    * 
+   * </p>
+   * <p>See http://www.gossamer-threads.com/lists/lucene/java-dev/47895 for more discussion. </p>
+   *
    * <p>Note that this requires substantial temporary free
    * space in the Directory (see <a target="_top"
    * href="http://issues.apache.org/jira/browse/LUCENE-764">LUCENE-764</a>