commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1187909 - in /commons/proper/functor/trunk/src/site/xdoc: building.xml examples.xml
Date Sun, 23 Oct 2011 15:52:19 GMT
Author: simonetripodi
Date: Sun Oct 23 15:52:19 2011
New Revision: 1187909

URL: http://svn.apache.org/viewvc?rev=1187909&view=rev
Log:
[FUNCTOR-2] Improve Functor web page, removing Ant from building

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

Modified: commons/proper/functor/trunk/src/site/xdoc/building.xml
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/site/xdoc/building.xml?rev=1187909&r1=1187908&r2=1187909&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/site/xdoc/building.xml (original)
+++ commons/proper/functor/trunk/src/site/xdoc/building.xml Sun Oct 23 15:52:19 2011
@@ -30,8 +30,8 @@
          <a href="source-repository.html">the SVN server</a>.
       </p>
       <p>
-         Commons Functor can be built using <a href="http://maven.apache.org/">Maven</a>
-         or <a href="http://ant.apache.org/">Ant</a>.  
+         In order to build Commons Functor you will need <a href="http://maven.apache.org/">Maven</a>.

+         Install a recent Maven release.
          <!--
          The <a href="http://jakarta.apache.org/gump">Gump</a>
          continuous integration process attempts to build Functor several times a day (against
the built-from-scratch
@@ -40,47 +40,11 @@
          <a href="http://cvs.apache.org/builds/gump/latest/commons-functor.html">view
the status of the latest gump build here</a>.
          -->
       </p>
-      <subsection name="Building with Maven">
-        <ol>
-          <li>
-            Install a recent Maven release.  Maven is available from 
-            <a href="http://maven.apache.org/">http://maven.apache.org/</a>.
-          </li>
-          <li>
+      <p>
             With Maven installed, you should be able to run an arbitrary maven goal from
the root Commons Functor 
-            directory.  Use <code>maven -g</code> for a list of avaiable goals.
 Commonly used goals include 
-            <code>clean</code>, <code>test</code>, <code>dist</code>,
<code>site</code> and <code>clover</code>.
-          </li>
-        </ol>
-      </subsection>      
-      <subsection name="Building with Ant">
-        <ol>
-          <li>
-            Install a recent Ant release.  Ant is available from 
-            <a href="http://ant.apache.org/">http://ant.apache.org/</a>.
-          </li>
-          <li>
-            Obtain JUnit 3.8.1 or later.  JUnit is available from 
-            <a href="http://junit.org/">http://junit.org/</a>.
-            Note that JUnit is a needed to compile and run the unit tests,
-            but is not needed at runtime by clients of Commons Functor.
-          </li>
-          <li>
-            Copy the <code>build.properties.sample</code> file found in the 
-            root Commons Functor directory to a file named <code>build.properties</code>.
-            Modify this file to provide the location of the <code>junit.jar</code>
file.
-            (Note that Commons Functor supports a "shared" <code>build.properties</code>

-            file placed either at <code>../build.properties</code> or
-            <code>../../jakarta-commons/build.properties</code>, or both, relative
to the 
-            root Commons Functor directory.)
-          </li>
-          <li>
-            You may run <code>ant -projecthelp</code> to obtain a list of the
available Ant targets.
-            Commonly used targets include <code>clean</code>, <code>test</code>,
<code>compile</code>,
-            <code>dist</code>, and <code>javadoc</code>.        
   
-          </li>
-        </ol>
-      </subsection>      
+            directory.  Commonly used goals include 
+            <code>clean</code>, <code>test</code>, <code>compile</code>,
<code>package</code>, <code>install</code> and <code>site</code>.
+      </p>
     </section>
   </body>
 </document>

Modified: commons/proper/functor/trunk/src/site/xdoc/examples.xml
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/site/xdoc/examples.xml?rev=1187909&r1=1187908&r2=1187909&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/functor/trunk/src/site/xdoc/examples.xml Sun Oct 23 15:52:19 2011
@@ -32,9 +32,9 @@
          In order to keep the examples in sync with the rest of the code,         
          each example is written as a <a href="http://junit.org/">JUnit</a> 
          <code>TestCase</code>.  The example programs are executed along with

-         all the other unit tests, and can be invoked via <code>ant test</code>
-         or <code>maven test</code> once you've set up Ant or Maven as described
-         in the <a href="building.html">build instructions</a>.
+         all the other unit tests, and can be invoked via <code>mvn test</code>

+         once you've set up Maven as described in the 
+         <a href="building.html">build instructions</a>.
       </p>
       <p>
          If you're not familiar with JUnit, don't worry. An understanding of 
@@ -43,24 +43,18 @@
       </p>
       <p>
          Two things you'll want to know about JUnit are (a) all the methods
-         whose names start with "test" will be executed automatically by the 
-         test suite and (b) there are various "assert" methods that can be used
-         to make assertions about the Objects being tested.  If any assertion
-         fails, the JUnit framework will count (and report) this as a test 
-         failure.
+         annotated with "@Test" will be executed automatically by the 
+         test runner and (b) there are various "assert" methods present in 
+         org.junit.Assert that can be used to make assertions about the Objects 
+         being tested.  If any assertion fails, the JUnit framework will count 
+         (and report) this as a test failure.
       </p>
-      <p>You can run a specific test case or sub-suite via Ant by invoking</p>
-      <pre>ant -Dtest.entry=&lt;fully-specified-test-case-name&gt; test</pre>
-      <p>or in Maven by invoking</p>
-      <pre>maven -Dtestcase=&lt;fully-specified-test-case-name&gt; test:single</pre>
+      <p>You can run a specific test case or sub-suite in Maven by invoking</p>
+      <pre>mvn -e -X -Dtest==&lt;fully-specified-test-case-name&gt; test</pre>
       <p>For example, to run the Quicksort example, invoke</p>
-      <pre>ant -Dtest.entry=org.apache.commons.functor.example.QuicksortExample test</pre>
-      <p>or</p>
-      <pre>maven -Dtestcase=org.apache.commons.functor.example.QuicksortExample test:single</pre>
+      <pre>mvn -e -X -Dtest=org.apache.commons.functor.example.QuicksortExample test</pre>
       <p>To run all the examples, invoke:</p>
-      <pre>ant -Dtest.entry=org.apache.commons.functor.example.TestAll test</pre>
-      <p>or</p>
-      <pre>maven -Dtestcase=org.apache.commons.functor.example.TestAll test:single</pre>
   
+      <pre>mvn -e -X -Dtest==&lt;fully-specified-package-name.*&gt; test</pre>
   
       <p>
          Each example is has descriptive prose mixed right in with the source, as 
          <code>/* C++ style */</code> comments.



Mime
View raw message