You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/04/17 21:52:48 UTC

svn commit: r1327245 - in /lucene/dev/trunk/lucene: LICENSE.txt MIGRATE.txt NOTICE.txt README.txt site/build/site/linkmap.html site/src/documentation/content/xdocs/site.xml

Author: rmuir
Date: Tue Apr 17 19:52:48 2012
New Revision: 1327245

URL: http://svn.apache.org/viewvc?rev=1327245&view=rev
Log:
LUCENE-3965: misc docs updates

Modified:
    lucene/dev/trunk/lucene/LICENSE.txt
    lucene/dev/trunk/lucene/MIGRATE.txt
    lucene/dev/trunk/lucene/NOTICE.txt
    lucene/dev/trunk/lucene/README.txt
    lucene/dev/trunk/lucene/site/build/site/linkmap.html
    lucene/dev/trunk/lucene/site/src/documentation/content/xdocs/site.xml

Modified: lucene/dev/trunk/lucene/LICENSE.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/LICENSE.txt?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/LICENSE.txt (original)
+++ lucene/dev/trunk/lucene/LICENSE.txt Tue Apr 17 19:52:48 2012
@@ -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 cop
  * 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
+ 

Modified: lucene/dev/trunk/lucene/MIGRATE.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/MIGRATE.txt?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/MIGRATE.txt (original)
+++ lucene/dev/trunk/lucene/MIGRATE.txt Tue Apr 17 19:52:48 2012
@@ -344,7 +344,7 @@ LUCENE-1458, LUCENE-2111: Flexible Index
   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 Index
   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 Index
   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

Modified: lucene/dev/trunk/lucene/NOTICE.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/NOTICE.txt?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/NOTICE.txt (original)
+++ lucene/dev/trunk/lucene/NOTICE.txt Tue Apr 17 19:52:48 2012
@@ -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 

Modified: lucene/dev/trunk/lucene/README.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/README.txt?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/README.txt (original)
+++ lucene/dev/trunk/lucene/README.txt Tue Apr 17 19:52:48 2012
@@ -14,30 +14,41 @@ Please join the Lucene-User mailing list
 
 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.
-  
-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.
+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
+  
 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.

Modified: lucene/dev/trunk/lucene/site/build/site/linkmap.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/site/build/site/linkmap.html?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/site/build/site/linkmap.html (original)
+++ lucene/dev/trunk/lucene/site/build/site/linkmap.html Tue Apr 17 19:52:48 2012
@@ -291,7 +291,7 @@ document.write("Last Published: " + docu
          
 <ul>
 <li>
-<a href="api/analyzers-morfologik/index.html">Analysis: Morfologik (Polish)</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>javadoc-analyzers-kuromoji</em>
+<a href="api/analyzers-morfologik/index.html">Analysis: Morfologik (Polish)</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>javadoc-analyzers-morfologik</em>
 </li>
 </ul>
          

Modified: lucene/dev/trunk/lucene/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/site/src/documentation/content/xdocs/site.xml?rev=1327245&r1=1327244&r2=1327245&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/site/src/documentation/content/xdocs/site.xml (original)
+++ lucene/dev/trunk/lucene/site/src/documentation/content/xdocs/site.xml Tue Apr 17 19:52:48 2012
@@ -49,7 +49,7 @@ See http://forrest.apache.org/docs/linki
          <javadoc-core label="Core" href="ext:javadocs-core"/>
          <javadoc-analyzers-common label="Analysis: Common" href="ext:javadocs-analyzers-common"/>
          <javadoc-analyzers-kuromoji label="Analysis: Kuromoji (Japanese)" href="ext:javadocs-analyzers-kuromoji"/>
-         <javadoc-analyzers-kuromoji label="Analysis: Morfologik (Polish)" href="ext:javadocs-analyzers-morfologik"/>
+         <javadoc-analyzers-morfologik label="Analysis: Morfologik (Polish)" href="ext:javadocs-analyzers-morfologik"/>
          <javadoc-analyzers-phonetic label="Analysis: Phonetic" href="ext:javadocs-analyzers-phonetic"/>
          <javadoc-analyzers-smartcn label="Analysis: Smart Chinese" href="ext:javadocs-analyzers-smartcn"/>
          <javadoc-analyzers-stempel label="Analysis: Stempel (Polish)" href="ext:javadocs-analyzers-stempel"/>