From c08a6288233567f97cc327abb2a64caad97163fd Mon Sep 17 00:00:00 2001 From: Glen Stampoultzis Date: Fri, 9 May 2003 10:12:58 +0000 Subject: [PATCH] no message git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353092 13f79535-47bb-0310-9956-ffa450edef68 --- .../content/xdocs/howtobuild.xml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 src/documentation/content/xdocs/howtobuild.xml diff --git a/src/documentation/content/xdocs/howtobuild.xml b/src/documentation/content/xdocs/howtobuild.xml new file mode 100644 index 0000000000..ae6c51b1ae --- /dev/null +++ b/src/documentation/content/xdocs/howtobuild.xml @@ -0,0 +1,143 @@ + + + + +
+ How To Build POI + + + +
+ +
+ Installing Ant +

+ The POI build system requires two components to perform a + build. + Ant and + forrest. +

+

+ Specifically the build has been tested to work with Ant version + 1.5.3 and Forrest 0.4. To install these products download + the distributions and follow the instructions in their + documentation. Make sure you don't forget to set the + environment variables FORREST_HOME and ANT_HOME. The + ANT_HOME/bin directory should be in the path. +

+

+ One these products are installed you will also need to + download some extra jar files required by the build. +

+ + + + + + + + + + + + + + + + + +
LibraryLocation
junithttp://www.ibiblio.org/maven/junit/jars/
xerceshttp://www.ibiblio.org/maven/xerces/jars/
jdependhttp://www.ibiblio.org/maven/jdepend/jars/
+

+ Just pick the latest versions of these jars and place + them in ANT_HOME/lib +

+
+
+ Running the Build +

+ On the first run the ant build system will download all + the jars required by the project to build ant. If you're + behind a firewall this may cause some problems. Should you + need to it's possible to manually put the jars in the + correct directories. These can be obtained from here: +

+ + JAR + Location + + + /commons-logging/jars/commons-logging-1.0.1.jar + lib + + + /log4j/jars/log4j-1.2.8.jar + lib + + + /commons-beanutils/jars/commons-beanutils-1.6.jar + src/contrib/lib + + + /commons-collections/jars/commons-collections-2.1.jar + src/contrib/lib + + + /commons-lang/jars/commons-lang-1.0-b1.jar + src/contrib/lib + + + /junit/jars/junit-3.8.1.jar + lib + +

+ The main targets of interest to our users are: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TargetDescription
cleanErase all build work products (ie, everything in the + build directory
compileCompiles all files from main, contrib and scratchpad
testRun all unit tests from main, contrib and scratchpad
docsGenerate all documentation for the system
generate-recordsGenerate records from the XML record defintitions
generate-typesGenerate types from the XML type definitions (this is + for HDF).
jarProduce jar files
distCreate a distribution.
clean-distRuns clean before creating the distribution.
+
+ + + +