lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r740373 - in /lucene/pylucene/site/src/documentation/content/xdocs: jcc/documentation/install.xml jcc/documentation/readme.xml tabs.xml
Date Tue, 03 Feb 2009 18:57:47 GMT
Author: vajda
Date: Tue Feb  3 18:57:47 2009
New Revision: 740373

corrections based on feedback by Mike


Modified: lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/install.xml
--- lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/install.xml (original)
+++ lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/install.xml Tue
Feb  3 18:57:47 2009
@@ -24,6 +24,19 @@
+    <section id="sources">
+      <title>Getting JCC's Source Code</title>
+      <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>
+      <p>
+	To get the JCC source code only from SVN use:<br/>
+	<code>$ svn co
+ jcc</code>
+      </p>
+    </section>
     <section id="build">
       <title>Building JCC</title>
@@ -36,7 +49,7 @@
 	  Edit <code></code> and review that values in
-	  the <code>INCLUDE</code>, <code>CFLAGS</code>,
+	  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></code>
@@ -66,7 +79,7 @@
     <section id="shared">
-      <title>Shared Mode: <code>--shared</code></title>
+      <title>Shared Mode: Support for the <code>--shared</code> Flag</title>
 	JCC includes a small runtime that keeps track of the Java VM and of
 	Java objects escaping it. Because there can be only one Java VM
@@ -118,12 +131,40 @@
 	Shared mode can be forced off by building JCC with
 	the <code>NO_SHARED</code> environment variable set.
+      <p>
+	There are two defaults to consider here:
+      </p>
+      <ul>
+	<li>
+	  Is JCC built with shared mode support or not ?
+	  <ul>
+	    <li>
+	      By default, on Mac OS X and Windows this is the case
+	    </li>
+	    <li>
+	      By default, on Linux, this is the case.
+	      if <code>setuptools</code> is patched.
+	    </li>
+	    <li>
+	      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
+	      shared library which is still an experimental feature.
+	    </li>
+	  </ul>
+	</li>
+	<li>
+	  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.
+	</li>
+      </ul>
     <section id="mac">
       <title>Notes for Mac OS X</title>
 	On Mac OS X, Java is installed by Apple's setup as a framework. The
-	values in <code></code> for <code>INCLUDE</code>
+	values in <code></code> for <code>INCLUDES</code>
 	and <code>LFLAGS</code> for <code>darwin</code> should be correct
 	and ready to use.

Modified: lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/readme.xml
--- lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/readme.xml (original)
+++ lucene/pylucene/site/src/documentation/content/xdocs/jcc/documentation/readme.xml Tue
Feb  3 18:57:47 2009
@@ -38,7 +38,7 @@
         via <code>distutils</code> or <code>setuptools</code>.
-        See <a href="site:jcc/documentation/install">here</a> for more
+        See <a href="site:jcc/documentation/install">installation</a> for more
         information and operating system specific notes.
@@ -516,8 +516,10 @@
       <title>Exception reporting</title>
 	Exceptions that occur in the Java VM and that escape to C++ are
-	reported as a <code>javaError</code> C++ exception. Failure to
-	handle the exception causes the process to crash.
+	reported as a <code>javaError</code> C++ exception. When using
+	Python wrappers, the C++ exceptions are handled and reported with
+	Python exceptions. When using C++ only, failure to handle the
+	exception in your C++ code will cause the process to crash.
 	Exceptions that occur in the Java VM and that escape to the Python

Modified: lucene/pylucene/site/src/documentation/content/xdocs/tabs.xml
--- lucene/pylucene/site/src/documentation/content/xdocs/tabs.xml (original)
+++ lucene/pylucene/site/src/documentation/content/xdocs/tabs.xml Tue Feb  3 18:57:47 2009
@@ -30,7 +30,7 @@
    Tabs can be embedded to a depth of two. The second level of tabs will only 
     be displayed when their parent tab is selected.    
-  <tab id="home" label="Home" dir="" indexfile="index.html"/>
+  <tab id="home" label="PyLucene" dir="" indexfile="index.html"/>
   <tab id="jcc" label="JCC" dir="jcc" indexfile="index.html"/>
 <!-- Add new tabs here, eg:
   <tab label="How-Tos" dir="community/howto/"/>

View raw message