From 2d221f79ad2061713c82d3edebde07cbd131f9be Mon Sep 17 00:00:00 2001
From: Michael McCandless <mikemccand@apache.org>
Date: Fri, 27 Mar 2009 09:19:05 +0000
Subject: [PATCH] add javadoc NOTE about package-private APIs for MergePolicy &
 MergeScheduler

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@759068 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/lucene/index/MergePolicy.java    | 7 +++++++
 src/java/org/apache/lucene/index/MergeScheduler.java | 7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/src/java/org/apache/lucene/index/MergePolicy.java b/src/java/org/apache/lucene/index/MergePolicy.java
index 7393215116c..df3b9210051 100644
--- a/src/java/org/apache/lucene/index/MergePolicy.java
+++ b/src/java/org/apache/lucene/index/MergePolicy.java
@@ -50,8 +50,15 @@ import java.util.Set;
  * 
  * <p>The default MergePolicy is {@link
  * LogByteSizeMergePolicy}.</p>
+ *
  * <p><b>NOTE:</b> This API is new and still experimental
  * (subject to change suddenly in the next release)</p>
+ *
+ * <p><b>NOTE</b>: This class typically requires access to
+ * package-private APIs (eg, SegmentInfos) to do its job;
+ * if you implement your own MergePolicy, you'll need to put
+ * it in package org.apache.lucene.index in order to use
+ * these APIs.
  */
 
 public abstract class MergePolicy {
diff --git a/src/java/org/apache/lucene/index/MergeScheduler.java b/src/java/org/apache/lucene/index/MergeScheduler.java
index f5ea10488d6..03568e09207 100644
--- a/src/java/org/apache/lucene/index/MergeScheduler.java
+++ b/src/java/org/apache/lucene/index/MergeScheduler.java
@@ -23,8 +23,15 @@ import java.io.IOException;
  *  implementing this interface to execute the merges
  *  selected by a {@link MergePolicy}.  The default
  *  MergeScheduler is {@link ConcurrentMergeScheduler}.</p>
+ *
  * <p><b>NOTE:</b> This API is new and still experimental
  * (subject to change suddenly in the next release)</p>
+ *
+ * <p><b>NOTE</b>: This class typically requires access to
+ * package-private APIs (eg, SegmentInfos) to do its job;
+ * if you implement your own MergePolicy, you'll need to put
+ * it in package org.apache.lucene.index in order to use
+ * these APIs.
 */
 
 public abstract class MergeScheduler {