From e8f899dc26216f9cd934b73be62a95fb72d67928 Mon Sep 17 00:00:00 2001
From: Shalin Shekhar Mangar <shalin@apache.org>
Date: Tue, 22 Sep 2009 19:50:27 +0000
Subject: [PATCH] SOLR-1366 -- Clear documentation/warning in example
 solrconfig.xml and changelist about using a custom IndexReaderFactory with
 ReplicationHandler

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@817801 13f79535-47bb-0310-9956-ffa450edef68
---
 CHANGES.txt                      |  4 +++-
 example/solr/conf/solrconfig.xml | 11 +++++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index deddc4ac39d..cf96c0244cd 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -262,7 +262,9 @@ New Features
     (Matthew Gregg, shalin)
     
 60. SOLR-243: Add configurable IndexReaderFactory so that alternate IndexReader implementations 
-    can be specified via solrconfig.xml. (Andrzej Bialecki, hossman, Mark Miller, John Wang)
+    can be specified via solrconfig.xml. Note that using a custom IndexReader may be incompatible
+    with ReplicationHandler (see comments in SOLR-1366). This should be treated as an experimental feature.
+    (Andrzej Bialecki, hossman, Mark Miller, John Wang)
     
 61. SOLR-1214: differentiate between solr home and instanceDir .deprecates the method SolrResourceLoader#locateInstanceDir()
     and it is renamed to locateSolrHome (noble)
diff --git a/example/solr/conf/solrconfig.xml b/example/solr/conf/solrconfig.xml
index fac9c37f386..056de615bd7 100755
--- a/example/solr/conf/solrconfig.xml
+++ b/example/solr/conf/solrconfig.xml
@@ -223,6 +223,17 @@
   
   <!-- Use the following format to specify a custom IndexReaderFactory - allows for alternate
        IndexReader implementations.
+
+       ** Experimental Feature **
+       Please note - Using a custom IndexReaderFactory may prevent certain other features
+       from working. The API to IndexReaderFactory may change without warning or may even
+       be removed from future releases if the problems cannot be resolved.
+
+       ** Features that may not work with custom IndexReaderFactory **
+       The ReplicationHandler assumes a disk-resident index. Using a custom
+       IndexReader implementation may cause incompatibility with ReplicationHandler and
+       may cause replication to not work correctly. See SOLR-1366 for details.
+
   <indexReaderFactory name="IndexReaderFactory" class="package.class">
     Parameters as required by the implementation
   </indexReaderFactory >