cmlenz 2002/12/26 06:50:39
Modified: documentation/docs/xdocs howto_build.xml
Log:
Add more details about the prerequisites, and bits of general cleanup
Revision Changes Path
1.3 +198 -53 jakarta-cactus/documentation/docs/xdocs/howto_build.xml
Index: howto_build.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/docs/xdocs/howto_build.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- howto_build.xml 13 Sep 2002 18:02:33 -0000 1.2
+++ howto_build.xml 26 Dec 2002 14:50:39 -0000 1.3
@@ -4,7 +4,7 @@
<document>
<header>
- <title>Building Cactus from the source</title>
+ <title>Building Cactus from the Source</title>
<authors>
<person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
</authors>
@@ -12,63 +12,207 @@
<body>
- <s1 title="Forewords">
+ <s1 title="Introduction">
<p>
- This tutorial explains how to build Cactus from CVS or from the
- Cactus source download
- (<code>jakarta-cactus-src-<version>.zip</code>).
+ This tutorial explains how to build Cactus from CVS or from a source
+ download.
</p>
<note>
- If you are purely a Cactus users, it may be easier to simply
- download a nightly build. Indeed Cactus is built every night and
- the result can be found on the
- <link href="downloads.html">download</link> page.
+ If you just want to use Cactus, it will be easier to simply download
+ a <link href="downloads.html">nightly build</link> (if you need the
+ latest and greatest), or the latest
+ <link href="downloads.html">stable release</link> otherwise.
</note>
</s1>
+ <s1 title="Getting the Source">
+ <p>
+ There are two ways to obtain the source code for Cactus: either
+ directly from CVS, or by downloading a prepackaged source archive.
+ </p>
+
+ <s2 title="CVS">
+ <p>
+ To get the current development version of the Cactus source code,
+ you'll need to download the source from CVS. To do this, you'll need
+ to have a CVS client installed.
+ </p>
+ <p>
+ Detailled instructions about accessing the Apache CVS repository can
+ be found
+ <link href="http://jakarta.apache.org/site/cvsindex.html";>here</link>
+ . The module name for Cactus is <code>jakarta-cactus</code>.
+ </p>
+ </s2>
+
+ <s2 title="Prepackaged Source Archives">
+ <p>
+ If you don't have access to the Apache CVS repository (because you're
+ behind a firewall, for example), or you don't need to be absolutely
+ up to date, you can download an archive containing a snapshot of the
+ Cactus code base.
+ </p>
+ <p>
+ Such archives are made available for each release as well as for the
+ nightly builds. Go <link href="downloads.html">here</link> to find
+ out about the download locations.
+ </p>
+ </s2>
+
+ </s1>
+
<s1 title="Prerequisites">
<p>
- You need to have Ant 1.5 or greater installed and containing the
- required Ant tasks and dependent jars. The easiest (and recommended
- way) is to download the prepackaged Cactus distribution for Ant, which
- is available in the
- <link href="downloads.html">download</link> area (click on
- "release", then select the latest release. You'll find the file
- there).
+ To build Cactus from source, you'll need to have
+ <link href="http://ant.apache.org/";>Ant</link> 1.5 (or later)
+ installed. Please make sure that the distribution also includes the JAR
+ containing the optional tasks (<code>optional.jar</code>). In addition,
+ please add an XSLT processor (like
+ <link href="http://xml.apache.org/xalan-j/";>Xalan</link> to the
+ <code>lib</code> directory of your Ant installation.
</p>
<p>
- Namely, the jars that you need to have in your <code>anthome/lib</code>
- directory are:
+ In addition, Cactus depends on a number of additional external
+ libraries at build time. These can be used by either placing them in
+ the <code>lib</code> directory of your Ant installation, or by
+ explicitly specifying their location in a
+ <code>build.properties</code> file at the root of the Cactus source
+ distribution.
</p>
- <ul>
- <li>
- <strong>Ant optional jar</strong>: <code>optional.jar</code>.
- </li>
- <li>
- <strong>AspectJ jars</strong>: <code>aspectj-ant.jar</code>,
- <code>aspectj-tools.jar</code> and <code>aspectj-rt.jar</code>.
- </li>
- <li>
- <strong>JUnit jar</strong>: <code>junit.jar</code>.
- </li>
- <li>
- <strong>Checkstyle related jars</strong>: <code>antlr.jar</code>
- <code>checkstyle.jar</code> and <code>jakarta-regexp.jar</code>.
- </li>
- <li>
- <strong>Xerces related jars</strong>: <code>xercesImpl.jar</code>
- and <code>xml-apis.jar</code>.
- </li>
- <li>
- <strong>Stylebook related jars</strong>:
- <code>stylebook.jar</code>, <code>xalan.jar</code>.
- </li>
- <li>
- <strong>Clover related jars (optional)</strong>:
- <code>clover.jar</code>, <code>velocity.jar</code> and
- <code>commons-collection.jar</code>.
- </li>
- </ul>
+
+ <s2 title="Required Libraries">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Version</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>junit.jar</td>
+ <td>3.7 or later</td>
+ <td>
+ The JUnit framework.
+ Availabe <link href="http://junit.org/";>here</link>.
+ This JAR file must be placed in the <code>lib</code> directory of
+ your Ant installation, or Ant will not be able to load the
+ required classes.
+ </td>
+ </tr>
+ <tr>
+ <td>aspectjrt.jar</td>
+ <td>1.0.6 or later</td>
+ <td>
+ The AspectJ runtime.
+ Availabe <link href="http://aspectj.org/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>aspectjtools.jar</td>
+ <td>1.0.6 or later</td>
+ <td>
+ The AspectJ compiler and other tools.
+ Availabe <link href="http://aspectj.org/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>aspectj-ant.jar</td>
+ <td>1.0.6 or later</td>
+ <td>
+ The AspectJ Ant tasks.
+ Availabe <link href="http://aspectj.org/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>stylebook.jar</td>
+ <td>1.0</td>
+ <td>
+ XML Stylebook (only for documentation).
+ Unfortunately, there is no real standalone distribution of the
+ Stylebook library. It can be found, for example, in the
+ XercesJ tools distributions (available
+ <link href="http://xml.apache.org/dist/xerces-j/";>here</link>).
+ </td>
+ </tr>
+ </table>
+ </s2>
+
+ <s2 title="Optional Libraries">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Version</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>checkstyle.jar</td>
+ <td>3.0-dev</td>
+ <td>
+ The Checkstyle code auditing tool.
+ Availabe <link href="http://checkstyle.sf.net/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>antlr.jar</td>
+ <td>2.7.1</td>
+ <td>
+ The ANTLR translator generator (required by Checkstyle).
+ Availabe <link href="http://antlr.org/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>commons-beanutils.jar</td>
+ <td>1.5</td>
+ <td>
+ Jakarta Commons BeanUtils (required by Checkstyle).
+ Available
+ <link
href="http://jakarta.apache.org/commons/beanutils.html";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>commons-collections.jar</td>
+ <td>2.1</td>
+ <td>
+ Jakarta Commons Collections (required by Checkstyle).
+ Available
+ <link
href="http://jakarta.apache.org/commons/collections.html";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>regexp.jar</td>
+ <td>1.2</td>
+ <td>
+ Jakarta RegExp (required by Checkstyle).
+ Available
+ <link href="http://jakarta.apache.org/regexp/";>here</link>.
+ </td>
+ </tr>
+ <tr>
+ <td>clover.jar</td>
+ <td>1.0</td>
+ <td>
+ Clover code coverage tool.
+ Available
+ <link href="http://www.thecortex.net/clover/";>here</link>.
+ This JAR file must be placed in the <code>lib</code> directory of
+ your Ant installation, or Ant will not be able to load the
+ required classes.
+ </td>
+ </tr>
+ <tr>
+ <td>velocity.jar</td>
+ <td>1.3</td>
+ <td>
+ Velocity template engine (required by Clover).
+ Available
+ <link href="http://jakarta.apache.org/velocity/";>here</link>,
+ but also included with the Clover download.
+ This JAR file must be placed in the <code>lib</code> directory of
+ your Ant installation, or Ant will not be able to load the
+ required classes.
+ </td>
+ </tr>
+ </table>
+ </s2>
<note>
<strong>If you don't want to have problems with versions, you need
@@ -99,17 +243,18 @@
</p>
<ul>
<li>
- anttasks: Some Ant tasks useful for Cactus
+ <strong>anttasks</strong>: Some Ant tasks useful for Cactus
</li>
<li>
- framework: The main Cactus framework
+ <strong>framework</strong>: The main Cactus framework
</li>
<li>
- sample-servlet: Sample application using Cactus. Also acts as
- functional and acceptance testing for the Cactus framework.
+ <strong>sample-servlet</strong>: Sample application using Cactus.
+ Currently also acts as functional and acceptance testing for the
+ Cactus framework.
</li>
<li>
- documentation: Cactus documentation
+ <strong>documentation</strong>: Cactus documentation
</li>
</ul>
<p>
@@ -160,4 +305,4 @@
</s1>
</body>
-</document>
\ No newline at end of file
+</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
