http://issues.apache.org/jira/browse/LUCENE-721 -- Added in Clover code coverage, thanks to Michael Busch.

Updated the xdocs with a new file named systemrequirements that details the system requirements for using Lucene.  Linked to them via the developer-resources and the releases page.  Regenerated the site.

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@485012 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Grant Ingersoll 2006-12-09 17:27:13 +00:00
parent 6ccabb7c8f
commit c67444564a
2 changed files with 377 additions and 0 deletions

View File

@ -0,0 +1,226 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.7">
<meta name="Forrest-skin-name" content="pelt">
<title>Apache Lucene - System Requirements</title>
<link type="text/css" href="skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
<link type="text/css" href="skin/profile.css" rel="stylesheet">
<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
<link rel="shortcut icon" href="images/favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<div class="breadtrail">
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://lucene.apache.org/">Lucene</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<div class="header">
<div class="grouplogo">
<a href="http://lucene.apache.org/"><img class="logoImage" alt="Lucene" src="http://www.apache.org/images/asf_logo_simple.png" title="Apache Lucene"></a>
</div>
<div class="projectlogo">
<a href="http://lucene.apache.org/java/"><img class="logoImage" alt="Lucene" src="http://lucene.apache.org/images/lucene_green_300.gif" title="Apache Lucene is a high-performance, full-featured text search engine library written entirely in
Java. It is a technology suitable for nearly any application that requires full-text search, especially cross-platform."></a>
</div>
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="lucene.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
<input attr="value" name="Search" value="Search" type="submit">
</form>
</div>
<ul id="tabs">
<li class="current">
<a class="base-selected" href="index.html">Main</a>
</li>
<li>
<a class="base-not-selected" href="http://wiki.apache.org/jakarta-lucene">Wiki</a>
</li>
</ul>
</div>
</div>
<div id="main">
<div id="publishedStrip">
<div id="level2tabs"></div>
<script type="text/javascript"><!--
document.write("<text>Last Published:</text> " + document.lastModified);
// --></script>
</div>
<div class="breadtrail">
&nbsp;
</div>
<div id="menu">
<div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">About</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
<a href="index.html" title="Welcome to Java Lucene">Overview</a>
</div>
<div class="menuitem">
<a href="features.html">Features</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/jakarta-lucene/PoweredBy">Powered by Lucene</a>
</div>
<div class="menuitem">
<a href="whoweare.html">Who We Are</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
<a href="api/">API Docs</a>
</div>
<div class="menuitem">
<a href="benchmarks.html">Benchmarks</a>
</div>
<div class="menuitem">
<a href="contributions.html">Contributions</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/jakarta-lucene/LuceneFAQ">FAQ</a>
</div>
<div class="menuitem">
<a href="fileformats.html">File Formats</a>
</div>
<div class="menuitem">
<a href="gettingstarted.html">Getting Started</a>
</div>
<div class="menuitem">
<a href="lucene-sandbox/index.html">Lucene Sandbox</a>
</div>
<div class="menuitem">
<a href="queryparsersyntax.html">Query Syntax</a>
</div>
<div class="menuitem">
<a href="scoring.html">Scoring</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/jakarta-lucene">Wiki</a>
</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Resources</div>
<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
<a href="developer-resources.html">Developers</a>
</div>
<div class="menuitem">
<a href="http://issues.apache.org/jira/browse/LUCENE">Issue Tracking</a>
</div>
<div class="menuitem">
<a href="mailinglists.html">Mailing Lists</a>
</div>
<div class="menuitem">
<a href="releases.html">Releases</a>
</div>
<div class="menupage">
<div class="menupagetitle">System Requirements</div>
</div>
<div class="menuitem">
<a href="http://svn.apache.org/viewcvs.cgi/lucene/java/">Version Control</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Site Versions</div>
<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
<a href="./">Main</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/java/1_4_3/">1.4.3</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/java/1_9_0/">1.9.0</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/java/1_9_1/">1.9.1</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/java/2_0_0/">2.0.0</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Related Projects</div>
<div id="menu_1.5" class="menuitemgroup">
<div class="menuitem">
<a href="http://lucene.apache.org">Lucene (Top-Level)</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/hadoop/">Hadoop</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/lucy/">Lucy</a>
</div>
<div class="menuitem">
<a href="http://incubator.apache.org/projects/lucene.net.html">Lucene.NET</a>
</div>
<div class="menuitem">
<a href="http://lucene.apache.org/nutch/">Nutch</a>
</div>
<div class="menuitem">
<a href="http://incubator.apache.org/solr/">SOLR</a>
</div>
</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<div id="credit2"></div>
</div>
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="systemrequirements.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<h1>Apache Lucene - System Requirements</h1>
<div id="minitoc-area">
<ul class="minitoc">
<li>
<a href="#System Requirements">System Requirements</a>
</li>
</ul>
</div>
<a name="N10013"></a><a name="System Requirements"></a>
<h2 class="boxed">System Requirements</h2>
<div class="section">
<p>
The latest Lucene <a href="releases.html">release</a> has the following minimum requirements:
<ul>
<li>Java 1.4.x or greater.</li>
<li>ANT 1.6.5 or greater.</li>
<li>JUnit 3.8.1 if you wish to run the unit tests.</li>
<li>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 <a href="benchmarks.html">benchmarks</a> page has some information related to performance on particular platforms.
Also, the <a href="http://svn.apache.org/viewvc/lucene/java/trunk/contrib/benchmark/">Contrib/benchmark</a> module has code related to benchmarking a standard set of documents.</li>
</ul>
</p>
<p>Contrib modules may have other requirements, refer to their documentation and build files for information.</p>
</div>
</div>
<div class="clearboth">&nbsp;</div>
</div>
<div id="footer">
<div class="lastmodified">
<script type="text/javascript"><!--
document.write("<text>Last Published:</text> " + document.lastModified);
// --></script>
</div>
<div class="copyright">
Copyright &copy;
2006 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
</div>
</body>
</html>

151
docs/systemrequirements.pdf Normal file
View File

@ -0,0 +1,151 @@
%PDF-1.3
%ª«¬­
4 0 obj
<< /Type /Info
/Producer (FOP 0.20.5) >>
endobj
5 0 obj
<< /Length 413 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
GauHFb>Q22']%q&m]nALH1nKW7iWO.8p9KoQ5#^;"Oa$^hb-lj.HB,mOdqnfc[FkJ'q3?+0S'P/)NjHd&:l.%5Yde8dFhD`0Mcad>Bis3G%J)0,8da<5J8?rLJ"$AO2H*hCg+Lm_'c2E)b.sPj."mIekU.kBq)I#A4D-U^8aJlPQK<=oRW(+1i5eXA<tq,G-e`BA3e+@,[B8lV`fkd^G`fRff^Xi%en,7G#4D+8qq_XFB-JI\]B(\)LLAK5^dnDI2UEYj_u!lK`>i`8RgO.!=:j^nY"7c9>ZaMOpkt9KWg\L-GaDpd4:Z/;I\8R&=g(#a@Jm%8mJ/)$BF5Yq0T_8](L(YrS\!F1a#7Y)N]hfG:USAXkTJr7@'?)Qpo]2Xhdk:ViD/S\XNlj7_<TP^nLF.(cSfQ~>
endstream
endobj
6 0 obj
<< /Type /Page
/Parent 1 0 R
/MediaBox [ 0 0 612 792 ]
/Resources 3 0 R
/Contents 5 0 R
/Annots 7 0 R
>>
endobj
7 0 obj
[
8 0 R
]
endobj
8 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 102.0 519.166 215.0 507.166 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A 9 0 R
/H /I
>>
endobj
10 0 obj
<< /Length 1021 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
Gat=*9lHOU&A@ZcHq^>qK>!Y5hNG7&'X^r1OAjU1bF2]eJ2]As]D_C[+,bm`Zr.Vfb8AS#^%%R0Y%-Wnm(>A3%\qBVU?:&PV"nS>'I'>2B`@,2*HE>?]?"WVq<tTNq1::oQ6&pDXdnk*FmNAi#)G)TillDi`\A(L+$lHu[kuif'GouR)8YM"K!o+5*Y5jAKs`#tCFp5RGZj9PoFo4<*H]_!]^(,"4WO=t!6#I&*?ejIcjn/7"XVe/3Y:hIgJd^>ijuGhk;q]NGcuA;'+G_cM7,kW6Y/%!j^+/j]2XSa'QjGo=cskQQ=HS*LhRClR8RX%$0cj+PIJJ"148RECJ&012i8PT$;\WR&]=$Yr2["U%.@^"+5oS=_\r5FV#Z?YiXcc=MTe7+A8R=>cs)TN$$'181H/0l:22C`:S[SMlqaCiq=_2"+[-83@]cG2>N6)EUcM3,0Q9khhT?*27$)IHMPLB+e#a<5fC8GOC_l+=6Xl9j-o*[d?PL,b"ZFfmWT'PrehX@sD0AX3h]/GeXG[euMNHceNm;r*PH_e^DoGQM-T!qHP_J+^')W39&B^_@$GZjF9ZHi%q:s]!5-X$X\h+Qf!YW.=2KOSUAMM>U-<61-!a__f*2ZD)5Yb1Od85reY1cEXb,=p;92m4c3_r!BGNPF897uAQQ#!ptOk#FB9`eC_"(`T(\ZYNacDbXP2T<I*KQ+Gk$.eR.4;&dH,$c(c,RV%s?N!6(PEkNh[^(7oV^t?'FF]n=@.I%W'YICLh$^`__-N//nJCIRlk?X_.V)P;*13.-_+p(#Ci*gh6N]ImZZCCb;2@@p(mbiNN1kch!DT=Abge=;408VdNWPiir\,m/N%@'3LS_OahL$?Nd"r_"JG!F-`KW5I4?F$mEXJ'LN6?0s+uB1M*pU5K3ep'OTM"#=Es.7Tn/1pK+f6DP5!u#V=HfLHFpB<OgK&&TfQKR'Lpa2IqUXpN7q[@2[J$B>WdWdm]9QT')c??r0t?>U2;5AoYdro=1cT;mpBS#F<b;~>
endstream
endobj
11 0 obj
<< /Type /Page
/Parent 1 0 R
/MediaBox [ 0 0 612 792 ]
/Resources 3 0 R
/Contents 10 0 R
>>
endobj
13 0 obj
<<
/Title (\376\377\0\61\0\40\0\123\0\171\0\163\0\164\0\145\0\155\0\40\0\122\0\145\0\161\0\165\0\151\0\162\0\145\0\155\0\145\0\156\0\164\0\163)
/Parent 12 0 R
/A 9 0 R
>> endobj
14 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F3
/BaseFont /Helvetica-Bold
/Encoding /WinAnsiEncoding >>
endobj
15 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F5
/BaseFont /Times-Roman
/Encoding /WinAnsiEncoding >>
endobj
16 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F1
/BaseFont /Helvetica
/Encoding /WinAnsiEncoding >>
endobj
17 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F2
/BaseFont /Helvetica-Oblique
/Encoding /WinAnsiEncoding >>
endobj
18 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F7
/BaseFont /Times-Bold
/Encoding /WinAnsiEncoding >>
endobj
1 0 obj
<< /Type /Pages
/Count 2
/Kids [6 0 R 11 0 R ] >>
endobj
2 0 obj
<< /Type /Catalog
/Pages 1 0 R
/Outlines 12 0 R
/PageMode /UseOutlines
>>
endobj
3 0 obj
<<
/Font << /F3 14 0 R /F5 15 0 R /F1 16 0 R /F2 17 0 R /F7 18 0 R >>
/ProcSet [ /PDF /ImageC /Text ] >>
endobj
9 0 obj
<<
/S /GoTo
/D [11 0 R /XYZ 85.0 659.0 null]
>>
endobj
12 0 obj
<<
/First 13 0 R
/Last 13 0 R
>> endobj
xref
0 19
0000000000 65535 f
0000002821 00000 n
0000002886 00000 n
0000002978 00000 n
0000000015 00000 n
0000000071 00000 n
0000000575 00000 n
0000000695 00000 n
0000000720 00000 n
0000003101 00000 n
0000000853 00000 n
0000001967 00000 n
0000003164 00000 n
0000002075 00000 n
0000002265 00000 n
0000002378 00000 n
0000002488 00000 n
0000002596 00000 n
0000002712 00000 n
trailer
<<
/Size 19
/Root 2 0 R
/Info 4 0 R
>>
startxref
3215
%%EOF