svn commit: r907802 - /lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java

[mi...@apache.org]

Author: mikemccand
Date: Mon Feb  8 21:19:18 2010
New Revision: 907802

URL: http://svn.apache.org/viewvc?rev=907802&view=rev
Log:
clarify that the NRT reader must be closed by the caller

Modified:
    lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java

Modified: lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java?rev=907802&r1=907801&r2=907802&view=diff
==============================================================================
--- lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/index/IndexWriter.java Mon Feb  8 21:19:18 2010
@@ -320,7 +320,10 @@
    * {#commit} and then using {@link IndexReader#open} to
    * open a new reader.  But the turarnound time of this
    * method should be faster since it avoids the potentially
-   * costly {@link #commit}.<p>
+   * costly {@link #commit}.</p>
+   *
+   * <p>You must close the {@link IndexReader} returned by
+   * this method once you are done using it.</p>
    *
    * <p>It's <i>near</i> real-time because there is no hard
    * guarantee on how quickly you can get a new reader after