svn commit: r1824170 - /lucene/cms/trunk/content/pylucene/jcc/install.mdtext

[va...@apache.org]

Author: vajda
Date: Tue Feb 13 20:03:51 2018
New Revision: 1824170

URL: http://svn.apache.org/viewvc?rev=1824170&view=rev
Log:
improved install docs, according to PYLUCENE-40

Modified:
    lucene/cms/trunk/content/pylucene/jcc/install.mdtext

Modified: lucene/cms/trunk/content/pylucene/jcc/install.mdtext
URL: http://svn.apache.org/viewvc/lucene/cms/trunk/content/pylucene/jcc/install.mdtext?rev=1824170&r1=1824169&r2=1824170&view=diff
==============================================================================
--- lucene/cms/trunk/content/pylucene/jcc/install.mdtext (original)
+++ lucene/cms/trunk/content/pylucene/jcc/install.mdtext Tue Feb 13 20:03:51 2018
@@ -20,14 +20,21 @@ via <i>distutils</i>
 or <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.
 
 
-- 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 <i>distutils</i> or <i>setuptools</i> to
-compile extensions it is generating code for.
+- On Mac OS X and Windows, <i>setup.py</i> will attempt to find a JDK on your
+system and report what it found by showing the values for <i>JAVAHOME</i> and
+<i>JAVAFRAMEWORKS</i> it was able to derive. If the JDK installation that was
+found is not the one you wish to use or if you are not on Mac OS X or Windows,
+you can either edit <i>setup.py</i> and review that the values in the
+<i>INCLUDES</i>, <i>CFLAGS</i>, <i>DEBUG_CFLAGS</i>, <i>LFLAGS</i>,
+<i>JAVAC</i>, and <i>JAVADOC</i> dicts are correct for your system or set
+<b>all</b> of the following environment variables, <i>JCC_JDK</i>,
+<i>JCC_INCLUDES</i>, <i>JCC_CFLAGS</i>, <i>JCC_DEBUG_CFLAGS</i>,
+<i>JCC_LFLAGS</i>, <i>JCC_JAVAC</i> and <i>JCC_JAVADOC</i>, using os.pathsep
+as value separator to override them.
+The values hereby configured are going to be compiled into JCC's
+<i>config.py</i> file and are going to be used by JCC when invoking
+<i>setuptools</i> to compile the extensions it is going to generate code for.
+
 - At the command line, enter:
 <code>
 $ python setup.py build<br/>
@@ -60,14 +67,13 @@ building plain shared libraries (as oppo
 Python extensions).
 
 
-Currently, shared mode is supported with <i>setuptools
-0.6c7</i> and above out of the box on macOS 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 <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>.
+Currently, shared mode is supported with <i>setuptools 0.6c7</i> and above out
+of the box on MacOSX 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 <i>jcc2/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>.
+<i>setup.py</i> will attempt to apply the patch for you via monkeypatching.
 
 
 The <i>shared mode disabled</i> error reported during the
@@ -103,7 +109,7 @@ There are two defaults to consider here:
 
 - Is JCC built with shared mode support or not ?
 
-    - By default, on macOS, Linux or Windows, this is the case when using a
+    - By default, on MacOSX, Linux or Windows, this is the case when using a
       modern version of <i>setuptools</i>
 
     - On other operating systems shared mode support is off by
@@ -117,16 +123,16 @@ There are two defaults to consider here:
 
 
 
-##Notes for Mac macOS
+##Notes for MacOSX
 
-On macOS, Java is installed by Apple's setup as a framework. The
+On MacOSX, Java is installed by Apple's setup as a framework. The
 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.
 
 
   However, if you intend to use the 'system' Python from a Java VM
-  on macOS -- Python embedded in Java --
+  on MacOSX -- Python embedded in Java --
   you will need to add the flags <i>"-framework", "Python"</i>
   to the <i>LFLAGS</i> value.