You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@maven.apache.org by be...@apache.org on 2010/09/13 13:15:46 UTC

svn commit: r996497 - /maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml

Author: bentmann
Date: Mon Sep 13 11:15:46 2010
New Revision: 996497

URL: http://svn.apache.org/viewvc?rev=996497&view=rev
Log:
o Clarified meaning of "@phase foo" which is often misunderstood by plugin authors

Modified:
    maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml

Modified: maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml?rev=996497&r1=996496&r2=996497&view=diff
==============================================================================
--- maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml (original)
+++ maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml Mon Sep 13 11:15:46 2010
@@ -447,9 +447,11 @@ under the License.
           <td>phase</td>
           <td>@phase &lt;phaseName&gt;</td>
           <td>No</td>
-          <td>Binds this Mojo to a particular phase of the standard build lifecycle, if specified.
-            <i>NOTE: This is only required if this Mojo is to participate in the standard build
-              process.</i>
+          <td>
+            Defines a default phase to bind a mojo execution to if the user does not explicitly set a phase in the POM.
+            <em>Note:</em> This annotation will not automagically make a mojo run when the plugin declaration is added
+            to the POM. It merely enables the user to omit the <code>&lt;phase&gt;</code> element from the surrounding
+            <code>&lt;execution&gt;</code> element.
           </td>
         </tr>
         <tr>