svn commit: r966506 - /gump/trunk/src/documentation/content/xdocs/metadata/builder.xml

[bo...@apache.org]

Author: bodewig
Date: Thu Jul 22 05:43:14 2010
New Revision: 966506

URL: http://svn.apache.org/viewvc?rev=966506&view=rev
Log:
mvn2install

Modified:
    gump/trunk/src/documentation/content/xdocs/metadata/builder.xml

Modified: gump/trunk/src/documentation/content/xdocs/metadata/builder.xml
URL: http://svn.apache.org/viewvc/gump/trunk/src/documentation/content/xdocs/metadata/builder.xml?rev=966506&r1=966505&r2=966506&view=diff
==============================================================================
--- gump/trunk/src/documentation/content/xdocs/metadata/builder.xml (original)
+++ gump/trunk/src/documentation/content/xdocs/metadata/builder.xml Thu Jul 22 05:43:14 2010
@@ -471,6 +471,90 @@
     </table>
   </section>
 
+  <section><title>mvn2install</title>
+    <p>Installs a file into the local Maven 2.x repository using the
+      mvn install plugin.</p>
+
+    <p>This element is a shortcut for a common use case of the mvn
+      builder which would otherwise involve several nested property
+      elements.  It uses mvn's "install:install-file" goal to install
+      the file given by the file attribute using the groupId of the
+      current project (or workspace) and the given or implied
+      artifactId.</p>
+    
+    <table>
+      <tr>
+        <th>Attribute</th>
+        <th>Description</th>
+        <th>Required?</th>
+      </tr>
+      <tr>
+        <td>version</td>
+        <td>The version of the artifact to install.</td>
+        <td>Yes.</td>
+      </tr>
+      <tr>
+        <td>file</td>
+        <td>The file to install (relative to basedir).</td>
+        <td>No. Defaults to "pom.xml".</td>
+      </tr>
+      <tr>
+        <td>packaging</td>
+        <td>The type of artifact to install.</td>
+        <td>No. Defaults to "pom".</td>
+      </tr>
+      <tr>
+        <td>artifactId</td>
+        <td>The id of the artifact to install.</td>
+        <td>No. Defaults to project's name.</td>
+      </tr>
+      <tr>
+        <td>profile</td>
+        <td>The Maven profile to activate.</td>
+        <td>No. Gump will use the default profile if the attribute has
+        not been set.</td>
+      </tr>
+      <tr>
+        <td>separateLocalRepository</td>
+        <td>Normally all &lt;mvn&gt; builds share the same local
+          repository that will be removed after each complete Gump run.
+          Sometimes a project needs to use a separate local repository
+          from the others, the most common case is that a project needs
+          to be built against a released dependency instead of a Gump
+          built one in order to break a dependency cycle.<br/>
+          The value of this attribute can be a boolean or an
+          identifier.  If you use a boolean it simply en- or
+          disables a local repository separate from the other
+          directories and Gump will choose a directory name (if the
+          value is true).  If several projects are tightly related
+          and should share the same local repository different from
+          the other projects you can use an id instead of a boolean
+          and use the same id for each project.
+        </td>
+        <td>No. Defaults to <strong>false</strong>.</td>
+      </tr>
+    </table>
+
+    <source><![CDATA[
+<project name="foo" groupId="bar">
+  <mvn2install version="1.0"/>
+</project>]]></source>
+
+    <p>is completely equivalent to</p>
+
+    <source><![CDATA[
+<project name="foo" groupId="bar">
+  <mvn goal="install:install-file">
+    <property name="groupId" value="bar"/>
+    <property name="artifactId" value="foo"/>
+    <property name="packaging" value="pom"/>
+    <property name="file" value="pom.xml"/>
+    <property name="version" value="1.0"/>
+  </mvn>
+</project>]]></source>
+
+  </section>
+
   <section><title>configure</title>
 
     <p>Is a specialized version of <link href="#script">script</link>