Author: ptahchiev
Date: Thu Jan 31 01:32:24 2008
New Revision: 617076
URL: http://svn.apache.org/viewvc?rev=617076&view=rev
Log:
Translated to the new release.
Modified:
jakarta/cactus/branches/CACTUS_TRUNK_MAMOUTH/cactus-site/src/site/xdoc/participating/howto_build.xml
Modified:
jakarta/cactus/branches/CACTUS_TRUNK_MAMOUTH/cactus-site/src/site/xdoc/participating/howto_build.xml
URL:
http://svn.apache.org/viewvc/jakarta/cactus/branches/CACTUS_TRUNK_MAMOUTH/cactus-site/src/site/xdoc/participating/howto_build.xml?rev=617076&r1=617075&r2=617076&view=diff
==============================================================================
---
jakarta/cactus/branches/CACTUS_TRUNK_MAMOUTH/cactus-site/src/site/xdoc/participating/howto_build.xml
(original)
+++
jakarta/cactus/branches/CACTUS_TRUNK_MAMOUTH/cactus-site/src/site/xdoc/participating/howto_build.xml
Thu Jan 31 01:32:24 2008
@@ -30,12 +30,12 @@
<section name="Introduction">
<p>
- This tutorial explains how to build Cactus from CVS or from a source
+ This tutorial explains how to build Cactus from SVN or from a source
download.
</p>
<note>
If you just want to use Cactus, it will be easier to simply download
- a <a href="cactus/downloads.html">nightly build</a> (if you need the
+ a <a href="../downloads.html">nightly build</a> (if you need the
latest and greatest), or the latest
<a href="../downloads.html">stable release</a> otherwise.
</note>
@@ -44,34 +44,32 @@
<section name="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.
+ directly from SVN, or by downloading a prepackaged source archive.
</p>
- <section name="CVS">
+ <section name="SVN">
<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.
+ you'll need to download the source from SVN. To do this, you'll need
+ to have a SVN client installed.
</p>
<p>
- Detailed instructions about accessing the Apache CVS repository can
+ Detailed instructions about accessing the Apache SVN repository can
be found
- <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>. The
module name for Cactus is
- <code>jakarta-cactus</code>.
+ <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>.
</p>
</section>
<section name="Prepackaged Source Archives">
<p>
- If you don't have access to the Apache CVS repository (because you're
+ If you don't have access to the Apache SVN 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 <a
href="http://jakarta.apache.org/cactus/downloads.html";>here</a> to find
- out about the download locations.
+ nightly builds. Go <a
href="http://jakarta.apache.org/cactus/downloads.html";>here</a> to find out
about the download locations.
</p>
</section>
@@ -84,18 +82,17 @@
present in your local filesystem for the build.
<strong>Do not worry!</strong> We won't ask you to fish around to
get these libraries :-)
- We have created an Ant script that does this automatically. The
+ The Maven2 build system does this automatically. The
next section on <a href="#build">Performing Builds</a>
explains how to use it.
</p>
- <section name="Ant">
+ <section name="Maven">
<p>
To build Cactus from source, you'll need to have
- <a href="http://ant.apache.org";>Ant</a> 1.6.1 (or later) installed.
For
- building the Maven plugin you'll need to have
- <a href="http://maven.apache.org";>Maven</a> 1.0 (or later) installed.
+ <a href="http://maven.apache.org";>Maven</a> 2.0.4 (or later)
installed. For building the samples module you'll need to have
+ <a href="http://ant.apache.org";>Ant</a> 1.6.5 (or later) installed.
</p>
<p>
@@ -161,12 +158,8 @@
<p>
In addition, Cactus depends on a number of additional external
- libraries at build time. The locations of these libraries on
- your file system should be specified in your
- <code>build.properties</code> file at the root of the Cactus
- source distribution. The next section on
- <jump anchor="build">Performing Builds</jump> explains how to
- automatically download these libraries.
+ libraries at build time. The Maven2 build system will download
+ automatically these dependencies in the local repository.
</p>
<table>
@@ -274,7 +267,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:regexp">regexp.jar</link>
+ <a href="http://jakarta.apache.org/regexp/";>regexp.jar</a>
</td>
<td nowrap="true">1.3</td>
<td>
@@ -283,17 +276,17 @@
</tr>
<tr>
<td>
- <link href="ext:httpunit">httpunit.jar</link>
+ <a href="http://httpunit.sourceforge.net/";>httpunit.jar</a>
</td>
<td nowrap="true">1.5.4</td>
<td>
HttpUnit. Required for testing the
- <link href="site:howto_httpunit">HttpUnit</link> integration.
+ <a href="../writing/howto_httpunit.html">HttpUnit</a>
integration.
</td>
</tr>
<tr>
<td nowrap="true">
- <link href="ext:nekohtml">nekohtml.jar</link>
+ <a
href="http://sourceforge.net/projects/nekohtml/";>nekohtml.jar</a>
</td>
<td nowrap="true">0.8.1</td>
<td>
@@ -302,7 +295,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:log4j">log4j.jar</link>
+ <a href="http://logging.apache.org/log4j/";>log4j.jar</a>
</td>
<td nowrap="true">1.2.8</td>
<td>
@@ -311,7 +304,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:taglibs_standard">jstl.jar</link>
+ <a href="http://java.sun.com/products/jsp/jstl/";>jstl.jar</a>
</td>
<td nowrap="true">1.0.2</td>
<td>
@@ -321,7 +314,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:taglibs_standard">standard.jar</link>
+ <a
href="http://jakarta.apache.org/taglibs/doc/standard-doc/intro.html";>standard.jar</a>
</td>
<td nowrap="true">1.0.2</td>
<td>
@@ -331,7 +324,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:jetty">jetty.jar</link>
+ <a href="http://mortbay.org/jetty/";>jetty.jar</a>
</td>
<td nowrap="true">4.2.17</td>
<td>
@@ -341,7 +334,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:jasper-compiler">jasper-compiler.jar</link>
+ <a
href="http://www.ibiblio.org/maven/tomcat/jars";>jasper-compiler.jar</a>
</td>
<td nowrap="true">4.1.30</td>
<td>
@@ -351,7 +344,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:jasper-runtime">jasper-runtime.jar</link>
+ <a
href="http://www.ibiblio.org/maven/tomcat/jars";>jasper-runtime.jar</a>
</td>
<td nowrap="true">4.1.30</td>
<td>
@@ -361,7 +354,7 @@
</tr>
<tr>
<td nowrap="true">
- <link href="ext:mockobjects">mockobjects-core.jar</link>
+ <a href="http://www.mockobjects.com/";>mockobjects-core.jar</a>
</td>
<td nowrap="true">0.09</td>
<td>
@@ -379,13 +372,13 @@
its own build:
</p>
<dl>
- <dt>documentation/</dt>
+ <dt>cactus-site/</dt>
<dd>
The Cactus documentation.
</dd>
<dt>framework/</dt>
<dd>
- The Cactus framework.
+ The Cactus framework itself.
</dd>
<dt>integration/</dt>
<dd>
@@ -393,17 +386,17 @@
<dl>
<dt>ant/</dt>
<dd>
- <link href="ext:ant">Ant</link> tasks and support classes
+ <a href="http://ant.apache.org/";>Ant</a> tasks and support
classes
provided by Cactus.
</dd>
<dt>eclipse/</dt>
<dd>
Plugins for integration with the open-source IDE
- <link href="ext:eclipse">Eclipse</link>.
+ <a href="http://www.eclipse.org/";>Eclipse</a>.
</dd>
<dt>maven/</dt>
<dd>
- <link href="ext:maven">Maven</link> plugins for Cactus.
+ <a href="http://maven.apache.org/";>Maven</a> plugins for Cactus.
</dd>
</dl>
</dd>
@@ -411,148 +404,63 @@
<dd>
Sample applications using Cactus.
<dl>
- <dt>jetty</dt>
- <dd>
- Sample application that demonstrates the use of the
- <link href="site:integration_jetty">Jetty integration</link>.
- </dd>
<dt>servlet</dt>
<dd>
Sample web-application using Cactus. It currently also acts as
functional and regression test suite for the Cactus framework.
+ (in order to build it correctly you will have to specify your
[TOMCAT_HOME] folder in the build.properties file in the samples directory)
</dd>
<dt>ejb</dt>
<dd>
Sample EJB using Cactus. It currently also acts as
functional and regression test suite for the Cactus framework.
+ (in order to build it correctly you will have to specify your
[JBOSS_HOME] folder in the build.properties file in the samples directory)
</dd>
</dl>
</dd>
</dl>
<p>
All modules follow a similar directory structure and they all use
- Ant as the build tool (except for the <code>maven/</code> module
- which is built with Maven.
+ Maven as the build tool.
</p>
</section>
- <section name="Performing Ant builds">
+ <section name="Performing Maven builds">
<p>
Good news: it should be extremely easy to build Cactus from the
sources! :-) After ensuring that you connected to internet, type the
- following 2 commands one after another:
- </p>
- <ul>
- <li>
- <strong><code>ant -f download.xml</code></strong>: This will
- automatically download all the required libraries. It takes about
- 5 minutes on a 512 kbps internet connection the first time. If you're
- behind a firewall, you'll need to read below how to customize the
- Cactus build as you'll need to edit your
<code>build.properties</code>
- file and supply proxy information.
- </li>
- <li>
- <strong><code>ant</code></strong>
- or <strong><code>ant dist</code></strong>: This will build
- the different Cactus modules for the default J2EE API (at the
- time of this writing the default is J2EE 1.3).
- </li>
- </ul>
- <p>
- The build result will be located in the <code>dist-*</code> directories
- of the different Cactud subprojects.
- </p>
-
- <p>
- Now, there are 2 files that you may wish to copy and edit if you wish
- to customize the Cactus build:
+ following command one after another:
</p>
<ul>
<li>
- <strong><code>build.properties.default</code></strong>: This file
- contains the default Cactus build configuration properties. You
should
- not edit it. Rather you should copy it to a file named
- <code>build.properties</code> which you can then edit. The file is
- self-documented.
- </li>
- <li>
- <strong><code>dependencies.xml.default</code></strong>: This file
- contains the list of Cactus library dependencies along with their
- versions. You should not edit this file. Rather, if you wish to use
- other versions, you should copy this file to a file named
- <code>dependencies.xml</code> which you can then edit.
+ <strong><code>mvn clean:install</code></strong>: This will
+ automatically download all the required dependencies. It takes about
+ 7 minutes on a 512 kbps internet connection the first time. If you're
+ behind a firewall, you'll need to read this <a
href="http://maven.apache.org/guides/mini/guide-proxies.html";>tutorial</a> for
specifying a proxy.
</li>
</ul>
-
- <p>
- To get help about the Ant targets available to build a given
subproject,
- open a shell, change into the module directory and execute
- <code>ant -projecthelp</code>. That will give you the list of
- available Ant targets:
- </p>
-
-<source><![CDATA[
-$ cd framework
-$ ant -projecthelp
-Buildfile: build.xml
-
- Cactus Framework
- ---------------------------------------------------------
- Contains the core classes of the Cactus in-container
- testing framework.
-
-Main targets:
-
- checkstyle Perform a code audit using Checkstyle
- clean Clean all generated files
- compile Compile the sources
- dist Generate the distributable files
- doc Generates the API documentation
- jar Generate the library jar
- test Run the unit tests
-
-Default target: dist]]>
-</source>
-
<p>
- Then, simply execute the target you need. To build the framework, you
- can invoke <code>ant dist</code> or just <code>ant</code> (because
- <em>dist</em> is the default target). If you just want to build the
- framework JAR or the API documentation, invoke <code>ant jar</code>
- or <code>ant doc</code>, respectively.
+ The build result will be located in the
<code>[USER_HOME]/.m2/repository/org/apache/cactus/</code> directory.
</p>
-<source><![CDATA[
-$ cd framework
-$ ant dist]]>
-</source>
<note>
Some projects depend on others and thus you may need to run the build
for those projects first. For example, the servlet sample depends on
the framework and the Ant integration, so these will need to be built
before the servlet sample is built. To avoid these problems you can
- simply type <code>ant dist</code> at the top level as it builds the
+ simply type <code>mvn install</code> at the top level as it builds the
different projects in the correct order.
</note>
<p>
Before creating a patch, and especially before committing changes, be
- sure to run both the <em>checkstyle</em> and <em>test</em> targets of
+ sure to run both the <em>checkstyle</em> and <em>test</em> plugins of
the corresponding module. Often we will also need to run the servlet
sample tests, because they effectively represent the regression test
suite for Cactus. You might want to simply perform a full rebuild to
be sure that nothing has been negatively affected by your changes.
</p>
</section>
-
- <section name="Generating the Maven plugin">
-
- <p>
- To generate the maven plugin, you must first perform the Ant build
(see above). Than you just need to go to the <code>integration/maven</code>
sub-directory and run <code>maven plugin:install</code>.
- </p>
-
- </section>
-
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
