svn commit: r543139 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml

[mb...@apache.org]

Author: mbaessler
Date: Thu May 31 07:09:24 2007
New Revision: 543139

URL: http://svn.apache.org/viewvc?view=rev&rev=543139
Log:
UIMA-377

update documentation and add PEAR verification details

JIRA ticket https://issues.apache.org/jira/browse/UIMA-377

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml?view=diff&rev=543139&r1=543138&r2=543139
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml Thu May 31 07:09:24 2007
@@ -624,6 +624,13 @@
       the PEAR installer tool (see <olink targetdoc="&uima_docs_tools;" 
           targetptr="ugr.tools.pear.installer"/>, or by an application using
       the PEAR APIs, directly. </para>
+    
+    <para>During the PEAR installation the PEAR file is extracted to the installation directory and the PEAR macros 
+    in the descriptors are updated with the corresponding path. At the end of the installation the PEAR verification 
+    is called to check if the installed PEAR package can be started successfully. The PEAR verification use the classpath,
+    datapath and the system property settings of the PEAR package to verify the PEAR content. Necessary Java library 
+    path settings for native libararies, PATH variable settings or system environment variables cannot be recognized 
+    automatically and the use must take care of that manually.</para>
       
     <section id="ugr.ref.pear.installing_pear_using_API">
       <title>Installing a PEAR file using the PEAR APIs</title>
@@ -720,7 +727,12 @@
     
     <para>To run an installed PEAR package directly in the UIMA framework the <literal>pearSpecifier</literal> 
     XML descriptor can be used. Typically during the PEAR installation such an specifier is automatically generated 
-    and contains all the necessary settings to run the installed PEAR package. The generated PEAR descriptor
+    and contains all the necessary information to run the installed PEAR package. Settings for system environment
+    variables, system PATH settings or Java library path settings cannot be recognized
+    automatically and must be set manually when the JVM is started. 
+    </para>
+    <para>
+    The generated PEAR descriptor
     is located in the component root directory of the installed PEAR package and has a filename like 
     &lt;componentID&gt;_pear.xml.</para>
     <para>The PEAR package descriptor looks like:</para>