Author: oheger
Date: Fri Jul 1 17:06:13 2016
New Revision: 1750983
URL: http://svn.apache.org/viewvc?rev=1750983&view=rev
Log:
[CONFIGURATION-628] Adapted building documentation.
Ant is no longer supported, so the corresponding section could be
removed.
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=1750983&r1=1750982&r2=1750983&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/building.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/building.xml Fri Jul 1
17:06:13 2016
@@ -27,18 +27,10 @@
<body>
- <section name="Overview">
+ <section name="Building">
<p>
- Commons Configuration can be built using
- <a href="http://maven.apache.org">maven</a> or
- <a href="http://ant.apache.org">ant</a>.
- </p>
- </section>
-
- <section name="Maven">
- <p>
- Commons Configuration uses Maven as its build tool. Any recent
version
- of Maven should work. To build the Configuration
+ Commons Configuration uses <a
href="http://maven.apache.org">maven</a> as its build tool.
+ Any recent version of Maven should work. To build the Configuration
jar, change into the directory where the source distribution
resides and run
"mvn install". This will compile the source and tests, run the
tests, and then
package the jar. The jar will also be copied into the local maven
repository
@@ -54,7 +46,7 @@
<p>
<code>TestWebdavConfigurationBuilder</code> is a functional test
that tests
DefaultConfigurationBuilder with the configuration files stored in
a WebDAV
- server. To run the test the steps that follow
+ server. To run the test, execute the steps that follow
<ol>
<li>Copy all the files in the conf directory to the WebDAV
server. Not all the
files are required but it is generally easier to use a tool like
cadaver
@@ -78,35 +70,5 @@
</ol>
</p>
</section>
-
- <section name="Building with Ant">
- <p>
- 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>
- 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>
-
</document>