Author: thobbs
Date: Tue Nov 9 12:21:26 2010
New Revision: 1032958
URL: http://svn.apache.org/viewvc?rev=1032958&view=rev
Log:
First draft of half of the "how to build and test River" page
Modified:
incubator/river/site/trunk/content/building-river.mdtext
Modified: incubator/river/site/trunk/content/building-river.mdtext
URL:
http://svn.apache.org/viewvc/incubator/river/site/trunk/content/building-river.mdtext?rev=1032958&r1=1032957&r2=1032958&view=diff
==============================================================================
--- incubator/river/site/trunk/content/building-river.mdtext (original)
+++ incubator/river/site/trunk/content/building-river.mdtext Tue Nov 9
12:21:26 2010
@@ -16,4 +16,76 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-# Building River
\ No newline at end of file
+# Building River
+
+Before you can start building River a word of warning;
+
+> The build process does not place nicely if you have spaces in your
+> path names
+
+So Windows users please be particular aware. Also, where path separators are
specified colons (:) should be used in preference to semi-colons (;) even on
Windows.
+
+## Check out the code
+
+See [this page](source-code.html) on how to check out the source code.
+
+## Build the distribution
+
+River can be built simply by running Ant from where you checked the code out
from.
+
+Assume "$RIVER_HOME" is where you have checked out the code to.
+
+ cd $RIVER_HOME
+ ant
+
+Will build all the River JARs required. You will then find them in the
${RIVER_HOME}/lib* directories.
+
+## Testing River
+
+This build process runs the (limited) suite of unit tests that comes with
River. River is tested predominantly by using
[jtreg](http://openjdk.java.net/jtreg/).
+
+
+
+
+*The following should be ignored, it has not been edited or checked yet.*
+
+create a file in the trunk directory called "build.properties"
+
+Then define the following properties in that file:
+
+river.home="file path to trunk"
+jtreg.home="path to jtreg install directory"
+jdk1.5.home="path to jdk1.5 directory" eg: jdk1.5.home="/usr/jdk/jdk1.5.0_15"
+jtreg.dir=C:\apache\river\jtsk\qa\jtreg
+
+Then in a directory relative to the one you choose for your working directory,
you must add a file named test.props
+
+the correct location for test.props:
+>
+> /**
+> * Returns extra test properties. Looks for the file "../../test.props"
+> * and reads it in as a Properties file. Assuming the working directory
+> * is "<path>/JTwork/scratch", this will find "<path>/test.props".
+> */
+
+My test.props contains the following two lines:
+
+jsk.home=/opt/src/river/trunk
+javatest.maxOutputSize=500000
+
+$jtreg -verbose:all,nopass -cpa: /opt/src/river/trunk/lib-platform -jdk
/usr/jdk/jdk1.5.0_15 -Djsk.home="/opt/src/river/trunk"
-Djava.security.debug=access,failure -Djavatest.maxOutputSize=500000 ./qa/jtreg/
+
+To run the tests manually, do the following:
+
+ 1. Copy the following files to JTlib-tmp; jsk-lib.jar,
+ jsk-platform.jar, jsk-resources.jar, phoenix-init.jar, jsk-policy.jar
+ 2. Execute the following jtreg command from the trunk directory,
+ change the paths to suit your environment.
+ 3. $ jtreg -verbose:all,nopass
+
-cpa:./qa/jtreg/JTlib-tmp/jsk.lib.jar:./qa/jtreg/JTlib-tmp/jsk-platform.jar:./qa/jtreg/JTlib-tmp/jsk-resources.jar:./qa/jtreg/JTlib-tmp/phoenix-init.jar:.jsk-policy.jar
+ -jdk /usr/jdk/jdk1.5.0_15 -Djsk.home="/opt/src/river/trunk"
+ -Djava.security.debug=access,failure
+ -Djavatest.maxOutputSize=500000 -Djtlib.tmp=./qa/jtreg/JTlib-tmp
+ ./qa/jtreg/
+
+c:/apache/jtreg/win32/bin/jtreg "-verbose:all,nopass"
"-cpa:./qa/jtreg/JTlib-tmp/jsk.lib.jar:./qa/jtreg/JTlib-tmp/jsk-platform.jar:./qa/jtreg/JTlib-tmp/jsk-resources.jar:./qa/jtreg/JTlib-tmp/phoenix-init.jar:.jsk-policy.jar:./qa/jtreg/JTlib-tmp/sun-util.jar"
-jdk "c:/Program Files/Java/jdk1.6.0_20"
-Djsk.home="c:/apache/river/jtsk/trunk" -Djava.security.debug=access,failure
-Djavatest.maxOutputSize=500000 -Djtlib.tmp=./qa/jtreg/JTlib-tmp ./qa/jtreg/
