From 715f0230576c37677902c2da4a080e11d0d0156c Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Mon, 15 Oct 2012 23:06:34 +0000 Subject: [PATCH] LUCENE-4006: Add system requirements page (markdown) git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1398564 13f79535-47bb-0310-9956-ffa450edef68 --- lucene/SYSTEM_REQUIREMENTS.txt | 16 ++++++++++++++++ lucene/build.xml | 3 ++- lucene/site/xsl/index.xsl | 1 + solr/SYSTEM_REQUIREMENTS.txt | 16 ++++++++++++++++ solr/build.xml | 10 ++++------ solr/site/xsl/index.xsl | 1 + 6 files changed, 40 insertions(+), 7 deletions(-) create mode 100644 lucene/SYSTEM_REQUIREMENTS.txt create mode 100644 solr/SYSTEM_REQUIREMENTS.txt diff --git a/lucene/SYSTEM_REQUIREMENTS.txt b/lucene/SYSTEM_REQUIREMENTS.txt new file mode 100644 index 00000000000..9b38cbf24f6 --- /dev/null +++ b/lucene/SYSTEM_REQUIREMENTS.txt @@ -0,0 +1,16 @@ +# System Requirements + +Apache Solr runs of Java 6 or greater. When using Java 7, be sure to +install at least Update 1! With all Java versions it is strongly +recommended to not use experimental `-XX` JVM options. It is also +recommended to always use the latest update version of your Java VM, +because bugs may affect Solr. An overview of known JVM bugs can be +found on http://wiki.apache.org/lucene-java/SunJavaBugs. + +CPU, disk and memory requirements are based on the many choices made in +implementing Solr (document size, number of documents, and number of +hits retrieved to name a few). The benchmarks page has some information +related to performance on particular platforms. + +*To build Apache Solr from source, refer to the `BUILD.txt` file in +the distribution directory.* diff --git a/lucene/build.xml b/lucene/build.xml index b26d455ec79..d8d3f0fb440 100644 --- a/lucene/build.xml +++ b/lucene/build.xml @@ -33,6 +33,7 @@ - + diff --git a/lucene/site/xsl/index.xsl b/lucene/site/xsl/index.xsl index 0984c10153b..bf77408d671 100644 --- a/lucene/site/xsl/index.xsl +++ b/lucene/site/xsl/index.xsl @@ -63,6 +63,7 @@

Reference Documents

  • Changes: List of changes in this release.
    • +
  • System Requirements: Minimum and supported Java versions.
  • Migration Guide: What changed in Lucene 4; how to migrate code from Lucene 3.x.
  • JRE Version Migration: Information about upgrading between major JRE versions.
  • File Formats: Guide to the supported index format used by Lucene. This can be customized by using an alternate codec.
    • diff --git a/solr/SYSTEM_REQUIREMENTS.txt b/solr/SYSTEM_REQUIREMENTS.txt new file mode 100644 index 00000000000..d5edcc6766e --- /dev/null +++ b/solr/SYSTEM_REQUIREMENTS.txt @@ -0,0 +1,16 @@ +# System Requirements + +Apache Lucene runs of Java 6 or greater. When using Java 7, be sure to +install at least Update 1! With all Java versions it is strongly +recommended to not use experimental `-XX` JVM options. It is also +recommended to always use the latest update version of your Java VM, +because bugs may affect Lucene. An overview of known JVM bugs can be +found on http://wiki.apache.org/lucene-java/SunJavaBugs. + +CPU, disk and memory requirements are based on the many choices made in +implementing Lucene (document size, number of documents, and number of +hits retrieved to name a few). The benchmarks page has some information +related to performance on particular platforms. + +*To build Apache Lucene from source, refer to the `BUILD.txt` file in +the distribution directory.* diff --git a/solr/build.xml b/solr/build.xml index f74b3726c35..b873957d62a 100644 --- a/solr/build.xml +++ b/solr/build.xml @@ -144,7 +144,7 @@ depends="javadocs,changes-to-html,process-webpages"/> - + @@ -163,12 +163,10 @@ - @@ -439,8 +437,8 @@ Changes: List of changes in this release. +
  • System Requirements: Minimum and supported Java versions.
  • Solr Tutorial: This document covers the basics of running Solr using an example schema, and some sample data.
  • Lucene Documentation