Author: niallp
Date: Tue May 20 15:59:23 2008
New Revision: 658479
URL: http://svn.apache.org/viewvc?rev=658479&view=rev
Log:
Update building instructions
Modified:
commons/proper/chain/trunk/xdocs/building.xml
Modified: commons/proper/chain/trunk/xdocs/building.xml
URL:
http://svn.apache.org/viewvc/commons/proper/chain/trunk/xdocs/building.xml?rev=658479&r1=658478&r2=658479&view=diff
==============================================================================
--- commons/proper/chain/trunk/xdocs/building.xml (original)
+++ commons/proper/chain/trunk/xdocs/building.xml Tue May 20 15:59:23 2008
@@ -24,81 +24,53 @@
<!-- ================================================== -->
<section name="Overview">
<p>
- Commons Chain uses <a href="http://maven.apache.org";>Maven</a> or
+ Commons Chain uses <a href="http://maven.apache.org/maven-1.x/";>Maven 1</a>,
+ <a href="http://maven.apache.org";>Maven 2</a> or
<a href="http://ant.apache.org";>Ant</a> as a build system.
</p>
+<p>
+ Chain 1.2 requires a minimum of JDK 1.3 to build, although the Maven 2 build
+ requires JDK 1.4+
+</p>
</section>
-<!-- ================================================== -->
-<section name="Maven Goals">
+<section name="Maven 2 Goals">
<p>
- To build a jar file, change into Chain's root directory and run
- <strong><code>maven jar</code></strong>.
- The result will be in the "target" subdirectory.
+ The following <strong><i>Maven 2</i></strong> commands can be used to
build io:
</p>
- <p>
- To build the Javadocs, run <strong><code>maven javadoc</code></strong>.
- The result will be in "target/docs/apidocs".
- </p>
- <p>
- To build the full website, run <strong><code>maven site</code></strong>.
- The result will be in "target/docs".
- </p>
- <p>
- Further details can be found in the
- <a href="http://commons.apache.org/building.html";>commons build
instructions</a>.
- </p>
- <subsection name="Changelog Report">
- <p>
- The default configuration for the
- <a href="http://maven.apache.org/maven-1.x/plugins/changelog/";>Changelog
Report</a>
- is to show changes within the last year. If however you wish to see
changes since a
- specified date you can override the configuration by adding a
<b>build.properties</b>
- file to the Commons Chain directory. For example to show all the changes
since the
- Chain 1.0 release, you would have the following in the
<b>build.properties</b>:
- </p>
- <p><source><![CDATA[
-maven.changelog.type=date
-maven.changelog.date=2004-12-09
-]]></source></p>
- <p>
- Unfortunately, an issue with Subversion imports means that this report
will only pick
- up changes since the last import - which in the case of the ASF
repository was December 2005.
- If you require the changelog report to show changes prior to December
2005 for Commons Chain
- then you can use the workaround described
- <a
href="http://www.niallp.pwp.blueyonder.co.uk/ChangelogSubversionIssue.html";>here</a>.
- </p>
- </subsection>
- <subsection name="Building With JDK 1.3">
- <p>
- Commons Chain can be built using <b>JDK 1.3</b> - however you will need
to modify the
- <b>project.xml</b> to add an additional dependency for <b>xml apis</b>:
- </p>
- <p><source><![CDATA[
-<dependency>
- <groupId>xml-apis</groupId>
- <artifactId>xml-apis</artifactId>
- <version>2.0.2</version>
- <url>http://xml.apache.org/commons/</url>
-</dependency>]]></source></p>
- </subsection>
+ <ul>
+ <li><code>mvn clean</code> - clean up</li>
+ <li><code>mvn test</code> - compile and run the unit tests</li>
+ <li><code>mvn site</code> - create io documentation</li>
+ <li><code>mvn package</code> - build the jar</li>
+ <li><code>mvn install</code> - build the jar and install in local maven
repository</li>
+ <li><code>mvn site assembly:assembly</code> - Create the source and binary
distributions</li>
+ </ul>
</section>
<!-- ================================================== -->
-<section name="Ant Goals">
+<section name="Maven 1.0 Goals">
<p>
- To build a jar file and the javadocs, change into Chain's root directory
- and run <strong><code>ant dist</code></strong>.
- The result will be in the "dist" subdirectory.
+ The following <strong><i>Maven 1.0</i></strong> commands can be used to
build io:
</p>
+ <ul>
+ <li><code>maven clean</code> - clean up</li>
+ <li><code>maven test</code> - compile and run the unit tests</li>
+ <li><code>maven site</code> - create io documentation</li>
+ <li><code>maven jar</code> - build the jar</li>
+ <li><code>maven dist</code> - Create the source and binary
distributions</li>
+ </ul>
</section>
-
<!-- ================================================== -->
-<section name="Nightly Builds">
+<section name="Ant Goals">
<p>
- <a
href="http://people.apache.org/builds/commons/nightly/commons-chain/";>Nightly
Builds</a>
- are built once a day from the current SVN HEAD. These are provided
purely for test purposes and are <b>NOT
- official releases</b> of the Apache Software Foundation - Released
versions of Commons Chain are
- available <a
href="http://commons.apache.org/downloads/download_chain.cgi";>here</a>.
+ The following <strong><i>Ant</i></strong> commands can be used to build io:
</p>
+ <ul>
+ <li><code>ant clean</code> - clean up</li>
+ <li><code>ant test</code> - compile and run the unit tests</li>
+ <li><code>ant javadoc</code> - create javadocs</li>
+ <li><code>ant jar</code> - build the jar</li>
+ <li><code>ant dist</code> - Create the source and binary distributions</li>
+ </ul>
</section>
<!-- ================================================== -->
</body>
