svn commit: r647516 - /commons/proper/collections/trunk/xdocs/building.xml

[ni...@apache.org]

Author: niallp
Date: Sat Apr 12 18:00:05 2008
New Revision: 647516

URL: http://svn.apache.org/viewvc?rev=647516&view=rev
Log:
Bring the build instructions up-to-date

Modified:
    commons/proper/collections/trunk/xdocs/building.xml

Modified: commons/proper/collections/trunk/xdocs/building.xml
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/xdocs/building.xml?rev=647516&r1=647515&r2=647516&view=diff
==============================================================================
--- commons/proper/collections/trunk/xdocs/building.xml (original)
+++ commons/proper/collections/trunk/xdocs/building.xml Sat Apr 12 18:00:05 2008
@@ -24,39 +24,53 @@
 <!-- ================================================== -->
 <section name="Building Commons Collections">
 <p>
-  Commons Collections uses <a href="http://ant.apache.org">Ant</a> as its
-  primary build system, however <a href="http://maven.apache.org">Maven</a>
-  is used for site generation.
+  Commons Collections uses <a href="http://maven.apache.org">Maven 2</a> as its
+  primary build system, however an <a href="http://ant.apache.org">Ant</a>
+  build is also available.
 </p>
 <p>
   You may also be interested in the <a href="release_3_2.html">v3.2 release notes</a>.
 </p>
 </section>
 <!-- ================================================== -->
-<section name="Ant Goals">
-  <p>
-    To build a jar file, change into Collection's root directory and run "ant jar".
-    The result will be in the "build" subdirectory.
-  </p>
-  <p>
-    All tests can be run with "ant test".
-    A single test can be run with "ant -Dtestcase=org.apache.commons.collections.TestXxx test".
-  </p>
+<section name="Maven 2 Goals">
   <p>
-    To build the Javadocs, run "ant javadoc".
-    The result will be in "build/docs/apidocs".
+    The following <strong><i>Maven 2</i></strong> commands can be used to build collections:
   </p>
+  <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="Maven Goals">
+<section name="Maven 1 Goals">
   <p>
-    To build the Javadocs, change into Collection's root directory and run "maven javadoc".
-    The result will be in "target/docs/apidocs".
+    The following <strong><i>Maven 1</i></strong> commands can be used to build collections:
   </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="Ant Goals">
   <p>
-    To build the full website, run "maven site".
-    The result will be in "target/docs".
+    The following <strong><i>Ant</i></strong> commands can be used to build collections:
   </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>