svn commit: r1673962 - in /lucene/dev/trunk: dev-tools/scripts/addBackcompatIndexes.py lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java

[sa...@apache.org]

Author: sarowe
Date: Wed Apr 15 21:36:00 2015
New Revision: 1673962

URL: http://svn.apache.org/r1673962
Log:
Backcompat index generation: add docs, and point to usage information on the wiki: http://wiki.apache.org/lucene-java/ReleaseTodo#Generate_Backcompat_Indexes

Modified:
    lucene/dev/trunk/dev-tools/scripts/addBackcompatIndexes.py
    lucene/dev/trunk/lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java

Modified: lucene/dev/trunk/dev-tools/scripts/addBackcompatIndexes.py
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/dev-tools/scripts/addBackcompatIndexes.py?rev=1673962&r1=1673961&r2=1673962&view=diff
==============================================================================
--- lucene/dev/trunk/dev-tools/scripts/addBackcompatIndexes.py (original)
+++ lucene/dev/trunk/dev-tools/scripts/addBackcompatIndexes.py Wed Apr 15 21:36:00 2015
@@ -13,6 +13,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+# For usage information, see:
+# 
+#   http://wiki.apache.org/lucene-java/ReleaseTodo#Generate_Backcompat_Indexes
+
+
 import os
 import sys
 sys.path.append(os.path.dirname(__file__))
@@ -182,7 +188,11 @@ def download_release(version, temp_dir,
   return source
 
 def read_config():
-  parser = argparse.ArgumentParser(description='Add backcompat index and test for new version')
+  parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
+                                   description='''\
+Add backcompat index and test for new version.  See:
+http://wiki.apache.org/lucene-java/ReleaseTodo#Generate_Backcompat_Indexes
+''')
   parser.add_argument('--force', action='store_true', default=False,
                       help='Redownload the version and rebuild, even if it already exists')
   parser.add_argument('--no-cleanup', dest='cleanup', action='store_false', default=True,

Modified: lucene/dev/trunk/lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java?rev=1673962&r1=1673961&r2=1673962&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java (original)
+++ lucene/dev/trunk/lucene/backward-codecs/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java Wed Apr 15 21:36:00 2015
@@ -77,11 +77,21 @@ import org.junit.AfterClass;
 import org.junit.BeforeClass;
 
 /*
-  Verify we can read the pre-5.0 file format, do searches
-  against it, and add documents to it.
+  Verify we can read previous versions' indexes, do searches
+  against them, and add documents to them.
 */
 public class TestBackwardsCompatibility extends LuceneTestCase {
 
+  // Backcompat index generation, described below, is mostly automated in: 
+  //
+  //    dev-tools/scripts/addBackCompatIndexes.py
+  //
+  // For usage information, see:
+  //
+  //    http://wiki.apache.org/lucene-java/ReleaseTodo#Generate_Backcompat_Indexes
+  //
+  // -----
+  //
   // To generate backcompat indexes with the current default codec, run the following ant command:
   //  ant test -Dtestcase=TestBackwardsCompatibility -Dtests.bwcdir=/path/to/store/indexes
   //           -Dtests.codec=default -Dtests.useSecurityManager=false