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

[mi...@apache.org]

Author: mikemccand
Date: Thu Apr  2 20:16:57 2009
New Revision: 761414

URL: http://svn.apache.org/viewvc?rev=761414&view=rev
Log:
make it clear that IW.commit() commits all changes, not just added/deleted docs

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?rev=761414&r1=761413&r2=761414&view=diff
==============================================================================
--- 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  2 20:16:57 2009
@@ -3592,12 +3592,13 @@
   }
 
   /**
-   * <p>Commits all pending updates (added & deleted
-   * documents) to the index, and syncs all referenced index
-   * files, such that a reader will see the changes and the
-   * index updates will survive an OS or machine crash or
-   * power loss.  Note that this does not wait for any
-   * running background merges to finish.  This may be a
+   * <p>Commits all pending changes (added & deleted
+   * documents, optimizations, segment merges, added
+   * indexes, etc.) to the index, and syncs all referenced
+   * index files, such that a reader will see the changes
+   * and the index updates will survive an OS or machine
+   * crash or power loss.  Note that this does not wait for
+   * any running background merges to finish.  This may be a
    * costly operation, so you should test the cost in your
    * application and do it only when really necessary.</p>
    *