Author: steveh
Date: Tue Mar 8 15:24:47 2005
New Revision: 156584
URL: http://svn.apache.org/viewcvs?view=rev&rev=156584
Log:
Calling out the counter-intuitive path for FORREST_HOME, which everyone seems
gets wrong the when they install Forrest on their machine.
Modified:
incubator/beehive/trunk/BUILDING.txt
Modified: incubator/beehive/trunk/BUILDING.txt
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/BUILDING.txt?view=diff&r1=156583&r2=156584
==============================================================================
--- incubator/beehive/trunk/BUILDING.txt (original)
+++ incubator/beehive/trunk/BUILDING.txt Tue Mar 8 15:24:47 2005
@@ -134,26 +134,26 @@
Building Beehive documentation
=============================
-In order to build the Beehive documentation, you will need to have
-Apache Forrest installed locally. The following targets in
-${beehive.home}/build.xml have this requirement:
+The following documentation-related targets in
+beehive/trunk/build.xml require that you have
+Apache Forrest installed locally:
$>ant docs
$>ant build.dist
Before running these targets, complete the following steps.
-1) Download a Forrest 0.6 archive from one of the following locations:
+1) Download and install Forrest 0.6 on your machine.
+Download locations are shown below:
For Windows machines:
http://mirrors.ccs.neu.edu/Apache/dist/forrest/apache-forrest-0.6.zip
For Unix machines:
http://mirrors.ccs.neu.edu/Apache/dist/forrest/apache-forrest-0.6.tar.gz
+
-2) Unzip the archive onto your machine. You may unzip to any location.
-
-3) Copy the JAR file
+2) Copy the JAR file
apache-forrest-0.6/lib/core/xml-commons-resolver-1.1.jar
@@ -163,7 +163,7 @@
(This allows the Ant targets to call Forrest tasks.)
-4) In the command shell (where you have already run beehiveEnv.cmd|.sh) set
FORREST_HOME as follows.
+3) Ensure that FORREST_HOME is set to the following path.
On Windows machines:
set FORREST_HOME=C:\MyApacheStuff\apache-forrest-0.6\src\core
@@ -171,7 +171,19 @@
On Unix machines:
export FORREST_HOME=/MyApacheStuff/apache-forrest-0.6/src/core
-5) Set the PATH as follows:
+
+ *****************************************************
+ * *
+ * Note: FORREST_HOME ends with the path element *
+ * *
+ * src/core *
+ * *
+ * If FORREST_HOME does not end with src/core, *
+ * the documentation-related targets will fail! *
+ * *
+ *****************************************************
+
+4) Set the PATH as follows:
On Windows machines:
set PATH=%FORREST_HOME%\bin;%PATH%
