You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by bu...@apache.org on 2012/08/23 01:48:17 UTC
svn commit: r829807 - in /websites/staging/lucene/trunk/content: ./
pylucene/jcc/install.html
Author: buildbot
Date: Wed Aug 22 23:48:16 2012
New Revision: 829807
Log:
Staging update by buildbot for lucene
Modified:
websites/staging/lucene/trunk/content/ (props changed)
websites/staging/lucene/trunk/content/pylucene/jcc/install.html
Propchange: websites/staging/lucene/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Aug 22 23:48:16 2012
@@ -1 +1 @@
-1376317
+1376318
Modified: websites/staging/lucene/trunk/content/pylucene/jcc/install.html
==============================================================================
--- websites/staging/lucene/trunk/content/pylucene/jcc/install.html (original)
+++ websites/staging/lucene/trunk/content/pylucene/jcc/install.html Wed Aug 22 23:48:16 2012
@@ -136,7 +136,7 @@
<div><h2 id="getting-jccs-source-code">Getting JCC's Source Code</h2>
<p>JCC's source code is included with PyLucene's. If you've downloaded
the PyLucene source code already, JCC's is to be found in
-the <code>jcc</code> subdirectory.</p>
+the <i>jcc</i> subdirectory.</p>
<p>To get the JCC source code only from SVN use:<br/>
<code>$ svn co
http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc jcc</code></p>
@@ -144,26 +144,26 @@ http://svn.apache.org/repos/asf/lucene/p
<p>JCC is a Python extension written in Python and C++. It requires a
Java Runtime Environment to operate as it uses Java's reflection
APIs to do its work. It is built and installed
-via <code>distutils</code>
+via <i>distutils</i>
or <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</p>
<ul>
-<li>Edit <code>setup.py</code> and review that values in
-the <code>INCLUDES</code>, <code>CFLAGS</code>,
-<code>DEBUG_CFLAGS</code>, <code>LFLAGS</code>
-and <code>JAVAC</code> are correct for your system. These values
-are also going to be compiled into JCC's <code>config.py</code>
+<li>Edit <i>setup.py</i> and review that values in
+the <i>INCLUDES</i>, <i>CFLAGS</i>,
+<i>DEBUG_CFLAGS</i>, <i>LFLAGS</i>
+and <i>JAVAC</i> are correct for your system. These values
+are also going to be compiled into JCC's <i>config.py</i>
file and are going to be used by JCC when
-invoking <code>distutils</code> or <code>setuptools</code> to
+invoking <i>distutils</i> or <i>setuptools</i> to
compile extensions it is generating code for.</li>
<li>At the command line, enter:
-<source>
-$ python setup.py build
-$ sudo python setup.py install
-</source></li>
+<code>
+$ python setup.py build<br/>
+$ sudo python setup.py install<br/>
+</code></li>
</ul>
<h2 id="requirements">Requirements</h2>
<p>JCC requires a Java Development Kit to be present. It uses the Java
-Native Invocation Interface and expects <code><jni.h></code>
+Native Invocation Interface and expects <i><jni.h></i>
and the Java libraries to be present at build and runtime.</p>
<p>JCC requires a C++ compiler. A recent C++ compiler for your
platform is expected to work as expected.</p>
@@ -173,27 +173,27 @@ Java objects escaping it. Because there
embedded in a given process at a time, the JCC runtime must be
compiled as a shared library when more than one JCC-built Python
extension is going to be imported into a given Python process.</p>
-<p>Shared mode depends on <code>setuptools</code>' capability of
+<p>Shared mode depends on <i>setuptools</i>' capability of
building plain shared libraries (as opposed to shared libraries for
Python extensions).</p>
-<p>Currently, shared mode is supported with <code>setuptools
-0.6c7</code> and above out of the box on Mac OS X and Windows. On
-Linux, a patch to <code>setuptools</code> needs to be applied
+<p>Currently, shared mode is supported with <i>setuptools
+0.6c7</i> and above out of the box on Mac OS X and Windows. On
+Linux, a patch to <i>setuptools</i> needs to be applied
first. This patch is included in the JCC source distribution in
-the <code>jcc/patches</code> directory, <code>patch.43</code>. This
-patch was submitted to the <code>setuptools</code> project
+the <i>jcc/patches</i> directory, <i>patch.43</i>. This
+patch was submitted to the <i>setuptools</i> project
via <a href="http://bugs.python.org/setuptools/issue43">issue
43</a>.</p>
-<p>The <code>shared mode disabled</code> error reported during the
+<p>The <i>shared mode disabled</i> error reported during the
build of JCC's on Linux contains the exact instructions on how to
-patch the <code>setuptools</code> installation
-with <code>patch.43</code> on your system.</p>
+patch the <i>setuptools</i> installation
+with <i>patch.43</i> on your system.</p>
<p>Shared mode is also required when embedding Python in a Java VM as
JCC's runtime shared library is used by the JVM to load JCC and
bootstrap the Python VM via the JNI.</p>
<p>When shared mode is not enabled, not supported
-or <code>distutils</code> is used instead
-of <code>setuptools</code>, static mode is used instead. The JCC
+or <i>distutils</i> is used instead
+of <i>setuptools</i>, static mode is used instead. The JCC
runtime code is statically linked with each JCC-built Python
extension and only one such extension can be used in a given Python
process at a time.</p>
@@ -201,7 +201,7 @@ process at a time.</p>
expected that more operating systems should be supported with shared
mode in the future.</p>
<p>Shared mode can be forced off by building JCC with
-the <code>NO_SHARED</code> environment variable set.</p>
+the <i>NO_SHARED</i> environment variable set.</p>
<p>There are two defaults to consider here:</p>
<ul>
<li>
@@ -212,29 +212,29 @@ the <code>NO_SHARED</code> environment v
</li>
<li>
<p>By default, on Linux, this is the case.
- if <code>setuptools</code> is patched.</p>
+ if <i>setuptools</i> is patched.</p>
</li>
<li>
<p>On other operating systems shared mode support is off by
default - not supported - because shared mode depends on
- <code>setuptools</code>'s capability of building a regular
+ <i>setuptools</i>'s capability of building a regular
shared library which is still an experimental feature.</p>
</li>
<li>
<p>Is a JCC-built Python extension built with shared mode ?<br/>
By default, no, shared mode is enabled only with
- the <code>--shared</code> command line argument.</p>
+ the <i>--shared</i> command line argument.</p>
</li>
</ul>
<h2 id="notes-for-mac-os-x">Notes for Mac OS X</h2>
<p>On Mac OS X, Java is installed by Apple's setup as a framework. The
-values in <code>setup.py</code> for <code>INCLUDES</code>
-and <code>LFLAGS</code> for <code>darwin</code> should be correct
+values in <i>setup.py</i> for <i>INCLUDES</i>
+and <i>LFLAGS</i> for <i>darwin</i> should be correct
and ready to use.</p>
<p>However, if you intend to use the 'system' Python from a Java VM
on Mac OS X -- Python embedded in Java --
- you will need to add the flags <code>"-framework", "Python"</code>
- to the <code>LFLAGS</code> value.</p>
+ you will need to add the flags <i>"-framework", "Python"</i>
+ to the <i>LFLAGS</i> value.</p>
<h2 id="notes-for-linux">Notes for Linux</h2>
<p>JCC has been built and tested on a variety of Linux distributions,
32- and 64-bit. Getting the java configuration correct is important
@@ -243,22 +243,22 @@ For example:</p>
<ul>
<li>
<p>On Ubuntu, to install Java 5, these commands may be used:
-<source>
- $ sudo apt-get install sun-java5-jdk
- $ sudo update-java-alternatives -s java-1.5.0-sun
-</source>
+<code>
+ $ sudo apt-get install sun-java5-jdk<br/>
+ $ sudo update-java-alternatives -s java-1.5.0-sun<br/>
+</code>
The samples flags for Linux in JCC's setup.py should be close to
correct.</p>
</li>
<li>
-<p>On Gentoo, the <code>java-config</code> utility should be used to
+<p>On Gentoo, the <i>java-config</i> utility should be used to
locate, and possibly change, the default java installation.
-The sample flags for Linux in JCC's <code>setup.py</code> should
+The sample flags for Linux in JCC's <i>setup.py</i> should
be changed to reflect the root of the Java installation which may
be obtained via:
-<source>
+<code>
$ java-config -O
-</source></p>
+</code></p>
</li>
</ul>
<p>See earlier section about <a href="#shared">Shared Mode</a> for
@@ -266,32 +266,32 @@ Linux support.</p>
<h2 id="notes-for-solaris">Notes for Solaris</h2>
<p>At this time, JCC has been built and tested only on Solaris 11 with Sun
Studio C++ 12, Java 1.6 and Python 2.4.</p>
-<p>Because JCC is written in C++, Python's <code>distutils</code> must
+<p>Because JCC is written in C++, Python's <i>distutils</i> must
be nudged a bit to invoke the correct compiler. Sun Studio's C
-compiler is called <code>cc</code> while its C++ compiler is
-called <code>CC</code>. To build JCC, use the following shell
+compiler is called <i>cc</i> while its C++ compiler is
+called <i>CC</i>. To build JCC, use the following shell
command to ensure that the C++ compiler is used:</p>
-<p><source>
+<p><code>
$ CC=CC python setup.py build
-</source></p>
+</code></p>
<p>Shared mode is not currently implemented for
-Solaris, <code>setuptools</code> needs to be taught how to build
+Solaris, <i>setuptools</i> needs to be taught how to build
plain shared libraries on Solaris first.</p>
<h2 id="notes-for-windows">Notes for Windows</h2>
<p>At this time, JCC has been built and tested on Win2k and WinXP with
a variety of Python and Java versions.</p>
<ul>
<li>
-<p>Adding the Python directory to <code>PATH</code> is recommended.</p>
+<p>Adding the Python directory to <i>PATH</i> is recommended.</p>
</li>
<li>
<p>Adding the Java directories containing the necessary DLLs and to
-<code>PATH</code> is a must.</p>
+<i>PATH</i> is a must.</p>
</li>
<li>
-<p>Adding the directory containing <code>javac.exe</code>
-to <code>PATH</code> is required for shared mode (enabled by
-default if <code>setuptools >= 0.6c7</code> is found to be
+<p>Adding the directory containing <i>javac.exe</i>
+to <i>PATH</i> is required for shared mode (enabled by
+default if <i>setuptools >= 0.6c7</i> is found to be
installed).</p>
</li>
</ul>
@@ -302,7 +302,7 @@ installed).</p>
<p>download <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</p>
</li>
<li>
-<p>edit the downloaded <code>setuptools</code> egg file to use
+<p>edit the downloaded <i>setuptools</i> egg file to use
python2.3 instead of python2.4.</p>
</li>
<li>