From c67250a8d5d0c58ed08124526c08327f0c2c6549 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Tue, 17 Apr 2012 19:52:48 +0000 Subject: [PATCH] LUCENE-3965: misc docs updates git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1327245 13f79535-47bb-0310-9956-ffa450edef68 --- lucene/LICENSE.txt | 14 ++--- lucene/MIGRATE.txt | 6 +-- lucene/NOTICE.txt | 8 +-- lucene/README.txt | 51 +++++++++++-------- lucene/site/build/site/linkmap.html | 2 +- .../src/documentation/content/xdocs/site.xml | 2 +- 6 files changed, 47 insertions(+), 36 deletions(-) diff --git a/lucene/LICENSE.txt b/lucene/LICENSE.txt index 554d0c03cf9..60c2b622399 100644 --- a/lucene/LICENSE.txt +++ b/lucene/LICENSE.txt @@ -203,7 +203,7 @@ -Some code in src/java/org/apache/lucene/util/UnicodeUtil.java was +Some code in core/src/java/org/apache/lucene/util/UnicodeUtil.java was derived from unicode conversion examples available at http://www.unicode.org/Public/PROGRAMS/CVTUTF. Here is the copyright from those sources: @@ -231,19 +231,19 @@ from those sources: */ -Some code in src/java/org/apache/lucene/util/ArrayUtil.java was +Some code in core/src/java/org/apache/lucene/util/ArrayUtil.java was derived from Python 2.4.2 sources available at http://www.python.org. Full license is here: http://www.python.org/download/releases/2.4.2/license/ -Some code in src/java/org/apache/lucene/util/UnicodeUtil.java was +Some code in core/src/java/org/apache/lucene/util/UnicodeUtil.java was derived from Python 3.1.2 sources available at http://www.python.org. Full license is here: http://www.python.org/download/releases/3.1.2/license/ -Some code in src/java/org/apache/lucene/util/automaton was +Some code in core/src/java/org/apache/lucene/util/automaton was derived from Brics automaton sources available at www.brics.dk/automaton/. Here is the copyright from those sources: @@ -274,7 +274,7 @@ www.brics.dk/automaton/. Here is the copyright from those sources: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -The levenshtein automata tables in src/java/org/apache/lucene/util/automaton +The levenshtein automata tables in core/src/java/org/apache/lucene/util/automaton were automatically generated with the moman/finenight FSA package. Here is the copyright for those sources: @@ -301,7 +301,7 @@ Here is the copyright for those sources: # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. -Some code in src/java/org/apache/lucene/util/UnicodeUtil.java was +Some code in core/src/java/org/apache/lucene/util/UnicodeUtil.java was derived from ICU (http://www.icu-project.org) The full license is available here: http://source.icu-project.org/repos/icu/icu/trunk/license.html @@ -333,4 +333,4 @@ The full license is available here: * dealings in this Software without prior written authorization of the * copyright holder. */ - \ No newline at end of file + diff --git a/lucene/MIGRATE.txt b/lucene/MIGRATE.txt index 2aebea08bc2..2a94e41c5c0 100644 --- a/lucene/MIGRATE.txt +++ b/lucene/MIGRATE.txt @@ -344,7 +344,7 @@ LUCENE-1458, LUCENE-2111: Flexible Indexing customizations won't run for certain MultiTermQuerys. * LUCENE-2413: Lucene's core and contrib analyzers, along with Solr's analyzers, - were consolidated into modules/analysis. During the refactoring some + were consolidated into lucene/analysis. During the refactoring some package names have changed: - o.a.l.analysis.KeywordAnalyzer -> o.a.l.analysis.core.KeywordAnalyzer - o.a.l.analysis.KeywordTokenizer -> o.a.l.analysis.core.KeywordTokenizer @@ -422,7 +422,7 @@ LUCENE-1458, LUCENE-2111: Flexible Indexing during indexing. * LUCENE-2883: Lucene's o.a.l.search.function ValueSource based functionality, was consolidated - into module/queries along with Solr's similar functionality. The following classes were moved: + into lucene/queries along with Solr's similar functionality. The following classes were moved: - o.a.l.search.function.CustomScoreQuery -> o.a.l.queries.CustomScoreQuery - o.a.l.search.function.CustomScoreProvider -> o.a.l.queries.CustomScoreProvider - o.a.l.search.function.NumericIndexDocValueSource -> o.a.l.queries.function.valuesource.NumericIndexDocValueSource @@ -467,7 +467,7 @@ LUCENE-1458, LUCENE-2111: Flexible Indexing scoring, override IndexSearcher's termStatistics() and collectionStatistics() methods instead. -* LUCENE-3283: Lucene's core o.a.l.queryParser QueryParsers have been consolidated into module/queryparser, +* LUCENE-3283: Lucene's core o.a.l.queryParser QueryParsers have been consolidated into lucene/queryparser, where other QueryParsers from the codebase will also be placed. The following classes were moved: - o.a.l.queryParser.CharStream -> o.a.l.queryparser.classic.CharStream - o.a.l.queryParser.FastCharStream -> o.a.l.queryparser.classic.FastCharStream diff --git a/lucene/NOTICE.txt b/lucene/NOTICE.txt index 5b5b3119a4b..a999fd1a71f 100644 --- a/lucene/NOTICE.txt +++ b/lucene/NOTICE.txt @@ -9,18 +9,18 @@ including, but not limited to: - Apache Ant - Apache Jakarta Regexp -ICU4J, (under contrib/icu) is licensed under an MIT styles license +ICU4J, (under analysis/icu) is licensed under an MIT styles license (contrib/icu/lib/ICU-LICENSE.txt) and Copyright (c) 1995-2008 International Business Machines Corporation and others -Some data files (under contrib/icu/src/data) are derived from Unicode data such +Some data files (under analysis/icu/src/data) are derived from Unicode data such as the Unicode Character Database. See http://unicode.org/copyright.html for more details. -Brics Automaton (under src/java/org/apache/lucene/util/automaton) is +Brics Automaton (under core/src/java/org/apache/lucene/util/automaton) is BSD-licensed, created by Anders Møller. See http://www.brics.dk/automaton/ -The levenshtein automata tables (under src/java/org/apache/lucene/util/automaton) were +The levenshtein automata tables (under core/src/java/org/apache/lucene/util/automaton) were automatically generated with the moman/finenight FSA library, created by Jean-Philippe Barrette-LaPierre. This library is available under an MIT license, see http://sites.google.com/site/rrettesite/moman and diff --git a/lucene/README.txt b/lucene/README.txt index ab5bf7d3e67..e4777471c54 100644 --- a/lucene/README.txt +++ b/lucene/README.txt @@ -14,30 +14,41 @@ Please join the Lucene-User mailing list by sending a message to: Files in a binary distribution: -lucene-core-XX.jar - The compiled Lucene library. +Files are organized by module, for example in core/: -lucene-core-XX-javadoc.jar - The Javadoc jar for the compiled Lucene library. +core/lucene-core-XX.jar + The compiled core Lucene library. + +core/lucene-core-XX-javadoc.jar + The Javadoc jar for the compiled core Lucene library. + +Additional modules contain the same structure: + +analysis/common/: Analyzers for indexing content in different languages and domains +analysis/kuromoji/: Analyzer for indexing Japanese +analysis/morfologik/: Analyzer for indexing Polish +analysis/phonetic/: Analyzer for indexing phonetic signatures (for sounds-alike search) +analysis/smartcn/: Analyzer for indexing Chinese +analysis/stempel/: Analyzer for indexing Polish +analysis/uima/: Analyzer that integrates with Apache UIMA +benchmark/: System for benchmarking Lucene +demo/: Simple example code +facet/: Faceted indexing and search capabilities +grouping/: Search result grouping +highlighter/: Highlights search keywords in results +join/: Index-time and Query-time joins for normalized content +memory/: Single-document in memory index implementation +misc/: Index tools and other miscellaneous code +queries/: Filters and Queries that add to core Lucene +queryparser/: Query parsers and parsing framework +sandbox/: Various third party contributions and new ideas. +spatial/: Geospatial search +suggest/: Auto-suggest and Spellchecking support +test-framework/: Test Framework for testing Lucene-based applications -lucene-test-framework-XX.jar - The compiled Lucene test-framework library. - Depends on junit 4.10.x (not 4.9.x, not 4.11.x), and Apache Ant 1.7.x (not 1.6.x, not 1.8.x) - -lucene-test-framework-XX-javadoc.jar - The Javadoc jar for the compiled Lucene test-framework library. - -contrib/demo/lucene-demo-XX.jar - The compiled simple example code. - -contrib/* - Contributed code which extends and enhances Lucene, but is not - part of the core library. Of special note are the JAR files in the analyzers directory which - contain various analyzers that people may find useful in place of the StandardAnalyzer. - docs/index.html The contents of the Lucene website. docs/api/index.html The Javadoc Lucene API documentation. This includes the core library, - the test framework, and the demo, as well as all of the contrib modules. + the test framework, and the demo, as well as all other modules. diff --git a/lucene/site/build/site/linkmap.html b/lucene/site/build/site/linkmap.html index 1ab662c7b8a..324c33b02e2 100644 --- a/lucene/site/build/site/linkmap.html +++ b/lucene/site/build/site/linkmap.html @@ -291,7 +291,7 @@ document.write("Last Published: " + document.lastModified); diff --git a/lucene/site/src/documentation/content/xdocs/site.xml b/lucene/site/src/documentation/content/xdocs/site.xml index 26575eb9514..57839f1a8c9 100755 --- a/lucene/site/src/documentation/content/xdocs/site.xml +++ b/lucene/site/src/documentation/content/xdocs/site.xml @@ -49,7 +49,7 @@ See http://forrest.apache.org/docs/linking.html for more info - +