From 047cf337b59c7c2c35482d6a0f83580517f814d0 Mon Sep 17 00:00:00 2001 From: Niall Kegan Pemberton Date: Sun, 13 Apr 2008 01:00:05 +0000 Subject: [PATCH] Bring the build instructions up-to-date git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@647516 13f79535-47bb-0310-9956-ffa450edef68 --- xdocs/building.xml | 52 +++++++++++++++++++++++++++++----------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/xdocs/building.xml b/xdocs/building.xml index 040dbfb8c..5d931ff9c 100644 --- a/xdocs/building.xml +++ b/xdocs/building.xml @@ -24,39 +24,53 @@ limitations under the License.

- Commons Collections uses Ant as its - primary build system, however Maven - is used for site generation. + Commons Collections uses Maven 2 as its + primary build system, however an Ant + build is also available.

You may also be interested in the v3.2 release notes.

-
+

- To build a jar file, change into Collection's root directory and run "ant jar". - The result will be in the "build" subdirectory. -

-

- All tests can be run with "ant test". - A single test can be run with "ant -Dtestcase=org.apache.commons.collections.TestXxx test". -

-

- To build the Javadocs, run "ant javadoc". - The result will be in "build/docs/apidocs". + The following Maven 2 commands can be used to build collections:

+
    +
  • mvn clean - clean up
  • +
  • mvn test - compile and run the unit tests
  • +
  • mvn site - create io documentation
  • +
  • mvn package - build the jar
  • +
  • mvn install - build the jar and install in local maven repository
  • +
  • mvn site assembly:assembly - Create the source and binary distributions
  • +
-
+

- To build the Javadocs, change into Collection's root directory and run "maven javadoc". - The result will be in "target/docs/apidocs". + The following Maven 1 commands can be used to build collections:

+
    +
  • maven clean - clean up
  • +
  • maven test - compile and run the unit tests
  • +
  • maven site - create io documentation
  • +
  • maven jar - build the jar
  • +
  • maven dist - Create the source and binary distributions
  • +
+
+ +

- To build the full website, run "maven site". - The result will be in "target/docs". + The following Ant commands can be used to build collections:

+
    +
  • ant clean - clean up
  • +
  • ant test - compile and run the unit tests
  • +
  • ant javadoc - create javadocs
  • +
  • ant jar - build the jar
  • +
  • ant dist - Create the source and binary distributions
  • +