[FOray-commit] SF.net SVN: foray: [7751] trunk/foray/doc/web/app/using/build.html

[<vic...@us...>]

Revision: 7751
Author:   victormote
Date:     2006-06-30 18:09:57 -0700 (Fri, 30 Jun 2006)
ViewCVS:  http://svn.sourceforge.net/foray/?rev=7751&view=rev

Log Message:
-----------
Fix outdated doc on build process.

Modified Paths:
--------------
    trunk/foray/doc/web/app/using/build.html
Modified: trunk/foray/doc/web/app/using/build.html
===================================================================
--- trunk/foray/doc/web/app/using/build.html	2006-07-01 00:45:29 UTC (rev 7750)
+++ trunk/foray/doc/web/app/using/build.html	2006-07-01 01:09:57 UTC (rev 7751)
@@ -58,48 +58,6 @@
   <li>A recent version of <a href="http://ant.apache.org/">Apache Ant</a>.</li>
 </ul>
 
-<p>Before running the build scripts, you must tell them about your environment.
-Set and export the following environment variables:</p>
-<ul>
-  <li><strong>$JAVA_HOME</strong>. Set JAVA_HOME to match the location of
-the JDK you wish to use.</li>
-  <li><strong>$ANT_HOME</strong>. Set ANT_HOME to match the location of the
-root of your Ant installatioin.</li>
-  <li><strong>$FORAY_ROOT</strong> (optional). If you run the build scripts
-from the script directories, FOray will automatically compute the FORAY_ROOT
-for you.
-Otherwise, set FORAY_ROOT to match the location of your foray source code.
-For example, if your foray-common module is at /u/foray/foray-common, set
-FORAY_ROOT = /u/foray.</li>
-  <li><strong>$FORAY_CONFIG</strong> (optional). If you wish to override the
-Ant properties used during the build without disturbing the build files
-themselves, set FORAY_CONFIG to a directory of your choosing, and create the
-appropriate Ant property file in that directory. Each build script looks for
-a specifically-named property file. Here are the standard file names:
-    <ul>
-      <li>foray-build-props.txt</li>
-      <li>foray-app-build-props.txt</li>
-      <li>foray-areatree-build-props.txt</li>
-      <li>foray-common-build-props.txt</li>
-      <li>foray-font-build-props.txt</li>
-      <li>foray-fotree-build-props.txt</li>
-      <li>foray-graphic-build-props.txt</li>
-      <li>foray-mif-build-props.txt</li>
-      <li>foray-pdf-build-props.txt</li>
-      <li>foray-pioneer-build-props.txt</li>
-      <li>foray-ps-build-props.txt</li>
-      <li>foray-render-build-props.txt</li>
-      <li>foray-text-build-props.txt</li>
-    </ul>
-    If you are using JAI and do not wish to place the JAI files in the
-FOray lib directory, you <em>must </em> place an entry in
-foray-graphic-build-props.txt similar to the following so that FOray knows
-where to find the JAI code:
-<pre>
-additional.libs = /u/rsrc/foray/lib-addons
-</pre>
-  </li>
-</ul>
 <p class="Warning">The manual steps needed to handle JAI are considered to be
 the least of the alternative evils, which include maintaining duplicate code,
 discontinuing support for PNG and TIFF, or dealing with the uncertain licensing
@@ -109,6 +67,32 @@
 support for the graphics types for which JAI is currently used, at which time
 this minor inconvenience will be eliminated.</p>
 
+<p>Before running the build scripts, you must tell them about your environment.
+Set and export the following environment variables:</p>
+<ul>
+  <li>$JAVA_HOME. Set this to the location of the JDK you wish to use.</li>
+  <li>$ANT_HOME. Set this to the location of the root of your Ant
+installatioin.</li>
+  <li><strong>$FORAY_CONFIG</strong> (optional).
+The default location of the FOray configuration directory is the FOray "scripts"
+directory, but this environment variable can be used to point to a different
+directory.
+If a file named "foray-build.properties" is found in the FOray configuration
+directory, it will be used by the build process.
+The useful properties that can be configured in that file are:
+<ul>
+  <li>foray.home = The root directory for FOray itself.</li>
+  <li>axsl.build = The location of an aXSL build that should be used instead of
+the build in the FOray "lib" directory.</li>
+  <li>ant.home = The root directory for Ant.</li>
+  <li>jai.libs = Directory containing JAI. If you are using JAI, you can either
+place the JAI libs in your FOray lib directory, or set a different directory
+using this entry.</li>
+  <li>checkstyle.home = Directory containing Checkstyle.</li>
+</ul>
+  </li>
+  </ul>
+
 <h2><a name="build">Run the Build Script</a></h2>
 <p>The actual build process can be started from foray/scripts/build.sh (for
 Unix/Linux) or foray/scripts/build.bat (for Windows).</p>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.