svn commit: r589639 - /lenya/trunk/INSTALL-SRC.txt

Author: nettings
Date: Mon Oct 29 07:34:46 2007
New Revision: 589639

URL: http://svn.apache.org/viewvc?rev=589639&view=rev
Log:
updated jdk version requirements, tomcat version, endorsed libs.
added blah about automated testing.


Modified:
    lenya/trunk/INSTALL-SRC.txt

Modified: lenya/trunk/INSTALL-SRC.txt
URL: http://svn.apache.org/viewvc/lenya/trunk/INSTALL-SRC.txt?rev=589639&r1=589638&r2=589639&view=diff
==============================================================================
--- lenya/trunk/INSTALL-SRC.txt (original)
+++ lenya/trunk/INSTALL-SRC.txt Mon Oct 29 07:34:46 2007
@@ -13,8 +13,15 @@
 
 
     * Java 2 Platform, Standard Edition
-      Recommended version: JDK 1.5 (used by most developers, 1.4.2 or later and 1.6 should also work).
-      Get the JDK at http://java.sun.com/javase/downloads/index_jdk5.jsp
+      Recommended version: JDK 1.5 (used by most developers). Java 1.4.2 or later should also
+      work, and people are using Java 1.6 successfully in day-to-day operation.
+      Get the JDK at http://java.sun.com/javase/downloads/index_jdk5.jsp.
+
+      WARNING: There have been numerous reports of spurious VM crashes with Java versions from 
+      1.5.0-07 to 1.5.0-11 both on Windows and Linux. Make sure you are using the latest available Java
+      5 package for your operating system (-13 as of this writing). 
+      If you encounter such crashes with more current revisions, please re-open 
+      http://issues.apache.org/bugzilla/show_bug.cgi?id=42493 .
 
     * Apache Cocoon
       Recommended version: BRANCH_2_1_X (https://svn.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X)
@@ -32,17 +39,17 @@
       All Linux distributions come with svn (or subversion) packages. Under Windows, you can either use 
       TortoiseSVN (see http://tortoisesvn.tigris.org) or the svn package included in Cygwin (http://cygwin.com).
 
-    * (optional) Apache Tomcat for JDK 1.4
-      version: 5.0.28 or newer, 5.5.x not tested.
-      source: http://jakarta.apache.org/site/binindex.cgi
+    * (optional) Apache Tomcat for JDK 1.5, version: 5.5.20 or later (earlier versions may work as well, 
+      but they are not tested).
+      Get the source at http://jakarta.apache.org/site/binindex.cgi
       Note that Lenya ships with Jetty and therefore does not need a servlet container to be installed.
 
 
+
 Standalone Installation (using the built-in Jetty)
 
 
-   This is the recommended mode of installation that is used by most
-   developers.
+   This is the recommended mode of installation that is used by most developers.
 
    1. Get the Java SDK (see Prerequisites): e.g. J2SDK_1.5.0-11
       and set JAVA_HOME
@@ -123,11 +130,10 @@
       with Java 2 SDK, Tomcat, Cocoon and Lenya.
 
       The following libraries must be placed in the endorsed library directory for your deployment.
-          * jakarta-bcel-20040329.jar
-          * jakarta-regexp-1.3.jar
-          * xalan-2.6.0.jar
-          * xercesImpl-2.6.2.jar
-          * xml-apis.jar
+          * xalan-2.7.0.jar
+          * xalan-2.7.0-serializer.jar
+          * xerces-2.9.0-xercesImpl.jar
+          * xerces-2.9.0-xml-apis.jar
 
       They are placed by the build process in the directory specified by tomcat.endorsed.dir in 
       build.properties. You should validate that these files are indeed in the proper location 
@@ -141,8 +147,10 @@
       Try carefully checking the location and version numbers of each of the libraries.
 
       References:
-          * Tomcat Class Loader HOWTO (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/class-loader-howto.html)
-          * Java 2 Endorsed Standards Override Mechanism (http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html)
+          * Tomcat Class Loader HOWTO 
+              (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/class-loader-howto.html)
+          * Java 2 Endorsed Standards Override Mechanism 
+              (http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html)
  
    6. Restart Tomcat
 
@@ -165,3 +173,12 @@
    makes it harder for an attacker to manipulate the system.
    FIXME: this needs more detailed documentation.
 
+
+Performing automated tests
+
+  If you are hacking Lenya (or you have healthy paranoia levels), you might want to run automated unit
+  and web tests on your Lenya checkout, especially after modifications. 
+  In the lenya-2.0.x directory, do
+  ./build.sh test    (to run the junit tests, requires a successful build), and
+  ./build.sh modules.test.canoo  (to run the canoo web tests, requires a running servlet engine).
+  
\ No newline at end of file