svn commit: r1197981 - /commons/proper/configuration/trunk/src/site/xdoc/building.xml

[oh...@apache.org]

Author: oheger
Date: Sat Nov  5 16:10:56 2011
New Revision: 1197981

URL: http://svn.apache.org/viewvc?rev=1197981&view=rev
Log:
[CONFIGURATION-470] Updated documentation related to building with Ant.

Modified:
    commons/proper/configuration/trunk/src/site/xdoc/building.xml

Modified: commons/proper/configuration/trunk/src/site/xdoc/building.xml
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/building.xml?rev=1197981&r1=1197980&r2=1197981&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/building.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/building.xml Sat Nov  5 16:10:56 2011
@@ -87,14 +87,32 @@
           </p>
         </section>
 
-        <section name="Ant Goals">
+        <section name="Building with Ant">
           <p>
-            To build a jar file, change into Configuration's root directory and run "ant jar".
-            The result will be in the "target" subdirectory.
+            In order to build the project with Apache Ant, some manual preparations
+            have to be done. The problem is that Commons Configuration uses
+            classes generated by <a href="http://javacc.java.net/">JavaCC</a>
+            to process configuration files in specific formats. These classes
+            are produced dynamically during the build process. While Maven is
+            able to download all required artifacts automatically, the Ant build
+            is not that smart. Therefore, it is required to download and install
+            JavaCC manually. Then a file named <code>build.properties</code> has
+            to be created in the root directory of Commons Configuration which
+            defines the <em>javacc_home</em> property; here the path to the
+            JavaCC installation has to be set. Commons Configuration already
+            ships with a <code>build.properties.sample</code> file which can be
+            copied and adapted correspondingly.
           </p>
           <p>
-            To build the Javadocs, run "ant javadoc".
-            The result will be in "target/site/apidocs".
+            After these preparations have been done, the following Ant goals
+            can be used:
+            <ul>
+              <li>To build a jar file, change into Configuration's root directory
+              and run "ant jar". The result will be in the "target" subdirectory.
+              </li>
+              <li>To build the Javadocs, run "ant javadoc". The result will be
+              in "target/site/apidocs".</li>
+            </ul>
           </p>
         </section>
     </body>