<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific iouage governing permissions and
limitations under the License.
-->
<document>
 <properties>
  <title>Building</title>
  <author email="dev@commons.apache.org">Commons Documentation Team</author>
 </properties>
<body>
<!-- ================================================== -->
<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.
</p>
<p>
  You may also be interested in the <a href="release_3_2_1.html">v3.2.1 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>
  <p>
    To build the Javadocs, run "ant javadoc".
    The result will be in "build/docs/apidocs".
  </p>
</section>
<!-- ================================================== -->
<section name="Maven 2 Goals">
  <p>
    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 1 Goals">
  <p>
    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>
    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>
</document>
