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

[be...@apache.org]

Author: bentmann
Date: Mon Sep 13 11:09:18 2010
New Revision: 996495

URL: http://svn.apache.org/viewvc?rev=996495&view=rev
Log:
[MNG-4293] Extend Mojo API to allow resolution of both compile and runtime dependencies

o Mentioned support for @requiresDependencyResolution compile+runtime

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=996495&r1=996494&r2=996495&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:09:18 2010
@@ -454,12 +454,57 @@ under the License.
         </tr>
         <tr>
           <td>requiresDependencyResolution</td>
-          <td>@requiresDependencyResolution &lt;requiredScope&gt;</td>
+          <td>@requiresDependencyResolution &lt;requiredClassPath&gt;</td>
           <td>No</td>
-          <td>Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope)
-            to be resolved before it can execute. Currently supports <code>compile</code>,
-              <code>runtime</code>, and <code>test</code> scopes. If this annotation is present but no scope
-              is specified, the scope defaults to <code>runtime</code>.
+          <td>
+            Flags this Mojo as requiring the dependencies in the specified class path to be resolved before it can
+            execute. The matrix below illustrates which values for <i>&lt;requiredClassPath&gt;</i> (first column) are
+            supported and which dependency scopes (first row) they will request to resolve:
+            <table>
+              <tr>
+                <td></td>
+                <td>system</td>
+                <td>provided</td>
+                <td>compile</td>
+                <td>runtime</td>
+                <td>test</td>
+              </tr>
+              <tr>
+                <td><code>compile</code></td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+                <td>-</td>
+                <td>-</td>
+              </tr>
+              <tr>
+                <td><code>runtime</code></td>
+                <td>-</td>
+                <td>-</td>
+                <td>X</td>
+                <td>X</td>
+                <td>-</td>
+              </tr>
+              <tr>
+                <td><code>compile+runtime</code> (since Maven 3.0)</td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+                <td>-</td>
+              </tr>
+              <tr>
+                <td><code>test</code></td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+                <td>X</td>
+              </tr>
+            </table>
+            If this annotation is present but no scope is specified, the scope defaults to <code>runtime</code>. If
+            the annotation is not present at all, the mojo must not make any assumptions about the artifacts associated
+            with a Maven project.
           </td>
         </tr>
         <tr>