From 56968b762add8b51b329c92e617496b200837385 Mon Sep 17 00:00:00 2001
From: Robert Muir <rmuir@apache.org>
Date: Sun, 12 Sep 2021 12:55:51 -0400
Subject: [PATCH] LUCENE-10098: add note/link to GermanAnalyzer for
 decompounding nouns. (#294)

LUCENE-10098: add note/link to GermanAnalyzer for decompounding nouns.

We can't do this out of box with the analyzer, due to incompatible
licenses. But we can make it easy on the user to do this, by linking to
repo that has sample code, documentation, and the required data files.
---
 lucene/CHANGES.txt                            | 29 +++++++++++++++++++
 .../lucene/analysis/de/GermanAnalyzer.java    |  7 +++++
 2 files changed, 36 insertions(+)

diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index c33a0bf542f..3390372856f 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -376,6 +376,35 @@ Other
 * LUCENE-10024: Catch NoSuchFileException when opening index directory with Luke.
   (Michael Wechner, Tomoko Uchida)
 
+======================= Lucene 8.11.0 =======================
+
+API Changes
+---------------------
+(No changes)
+
+New Features
+---------------------
+(No changes)
+
+Improvements
+---------------------
+
+* LUCENE-9662: Make CheckIndex concurrent by parallelizing index check across segments.
+  (Zach Chen, Mike McCandless, Dawid Weiss, Robert Muir)
+
+Optimizations
+---------------------
+(No changes)
+
+Bug Fixes
+---------------------
+(No changes)
+
+Other
+---------------------
+
+* LUCENE-10098: Add docs/links to GermanAnalyzer describing how to decompound nouns. (Robert Muir)
+
 ======================= Lucene 8.10.0 =======================
 
 API Changes
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanAnalyzer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanAnalyzer.java
index c5e55d58c0b..9e2829ac0a2 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanAnalyzer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanAnalyzer.java
@@ -45,7 +45,14 @@ import org.apache.lucene.util.IOUtils;
  * <p><b>NOTE</b>: This class uses the same {@link org.apache.lucene.util.Version} dependent
  * settings as {@link StandardAnalyzer}.
  *
+ * <p><b>NOTE</b>: This class does not decompound nouns, additional data files are needed,
+ * incompatible with the Apache 2.0 License. You can find these data files and example code for
+ * decompounding <a
+ * href="https://github.com/uschindler/german-decompounder#lucene-api-example">here</a>.
+ *
  * @since 3.1
+ * @see <a
+ *     href="https://github.com/uschindler/german-decompounder">https://github.com/uschindler/german-decompounder</a>
  */
 public final class GermanAnalyzer extends StopwordAnalyzerBase {