Author: aramirez
Date: Wed Jul 5 04:10:01 2006
New Revision: 419214
URL: http://svn.apache.org/viewvc?rev=419214&view=rev
Log:
PR: MINSTALL-27
-pass the docck check
-created initial content
Added:
maven/plugins/trunk/maven-install-plugin/src/site/
maven/plugins/trunk/maven-install-plugin/src/site/apt/
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/install-updateReleaseInfo.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/faq.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt
Modified:
maven/plugins/trunk/maven-install-plugin/pom.xml
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallMojo.java
Modified: maven/plugins/trunk/maven-install-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/pom.xml?rev=419214&r1=419213&r2=419214&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-install-plugin/pom.xml Wed Jul 5 04:10:01 2006
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-install-plugin</artifactId>
@@ -10,6 +10,25 @@
<name>Maven Install Plugin</name>
<version>2.2-SNAPSHOT</version>
<inceptionYear>2004</inceptionYear>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </reporting>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Modified:
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java?rev=419214&r1=419213&r2=419214&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
Wed Jul 5 04:10:01 2006
@@ -57,6 +57,8 @@
private Digester digester;
/**
+ * Flag whether to create checksums(MD5, SHA1) or not.
+ *
* @parameter expression="${createChecksum}" default-value="false"
*/
protected boolean createChecksum;
Modified:
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java?rev=419214&r1=419213&r2=419214&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
Wed Jul 5 04:10:01 2006
@@ -50,37 +50,53 @@
extends AbstractInstallMojo
{
/**
+ * GroupId of the artifact to be installed. Retrieved from POM file if
specified.
+ *
* @parameter expression="${groupId}"
*/
protected String groupId;
/**
+ * ArtifactId of the artifact to be installed. Retrieved from POM file if
specified.
+ *
* @parameter expression="${artifactId}"
*/
protected String artifactId;
/**
+ * Version of the artifact to be installed. Retrieved from POM file if
specified
+ *
* @parameter expression="${version}"
*/
protected String version;
/**
+ * Packaging type of the artifact to be installed. Retrieved from POM file
if specified
+ *
* @parameter expression="${packaging}"
*/
protected String packaging;
/**
+ * The file to be deployed
+ *
* @parameter expression="${file}"
* @required
*/
private File file;
/**
+ * Location of an existing POM file to be deployed alongside the main
+ * artifact, given by the ${file} parameter.
+ *
* @parameter expression="${pomFile}"
*/
private File pomFile;
/**
+ * Install a POM for this artifact. Will generate a default POM if none is
+ * supplied with the pomFile argument.
+ *
* @parameter expression="${generatePom}"
*/
private boolean generatePom = false;
Modified:
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallMojo.java?rev=419214&r1=419213&r2=419214&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallMojo.java
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallMojo.java
Wed Jul 5 04:10:01 2006
@@ -52,6 +52,8 @@
private File pomFile;
/**
+ * Whether to update the metadata to make the artifact as release.
+ *
* @parameter expression="${updateReleaseInfo}"
*/
private boolean updateReleaseInfo = false;
Added:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/install-updateReleaseInfo.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/install-updateReleaseInfo.apt?rev=419214&view=auto
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/install-updateReleaseInfo.apt
(added)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/install-updateReleaseInfo.apt
Wed Jul 5 04:10:01 2006
@@ -0,0 +1,12 @@
+ ------
+ Maven 2 Install Plugin - updateReleaseInfo parameter
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Updating the plugin release
+
+
+
Added: maven/plugins/trunk/maven-install-plugin/src/site/apt/faq.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/faq.apt?rev=419214&view=auto
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/faq.apt (added)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/faq.apt Wed Jul 5
04:10:01 2006
@@ -0,0 +1,9 @@
+ ------
+ Maven 2 Install Plugin - Frequently Asked Questions
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Frequently Asked Questions
Added: maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt?rev=419214&view=auto
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt Wed Jul 5
04:10:01 2006
@@ -0,0 +1,42 @@
+ ------
+ Maven 2 Install Plugin
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Maven 2 Install Plugin - Introduction
+
+ Local Repository is the local cached of a remote repository where
+ all artifacts needed for the build are stored. By default, it is located at
+ the user home directory (~/.m2/repository) and can be configured in the
+ <<<settings.xml>>> at \<localRepository\> element.
+
+ The install plugin is used during the install phase, to place or add the
+ artifact(s) to the local repository correctly. The install plugin uses
+ the information in the POM(groupId, artifactId, version) to determine
+ the installation path of the artifact in order for maven to picked
+ it up correctly.
+
+* Goals Overview
+
+ The install plugin has 2 goals:
+
+ * {{{index.html}install:install}} is used to automatically install the
+ artifact in the local repository, its pom and the attached artifacts
+ produced by a particular project.
+
+ * {{{index.html}install:install-file}} is mostly used to install a single
+ or 3rd party artifact along with its pom. In that case the artifact
+ information can be taken from an optionally specified pomFile, but can
+ be completed/overriden using the command line.
+
+* Usage
+
+ Some basic instructions for configuring and using the mojos of the
+ <<<maven-install-plugin>>> can be found in the {{{usage.html}Usage}}.
+
+* Examples
+
+ Sample use-cases for the plugin are available under the Examples menu
\ No newline at end of file
Added: maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt?rev=419214&view=auto
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt (added)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt Wed Jul 5
04:10:01 2006
@@ -0,0 +1,45 @@
+ ------
+ Maven 2 Install Plugin - Usage
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Usage
+
+* The <<<install:install>>> Mojo
+
+ In most cases, install:install goal doesnt need any configurations, it
+ needs the project's POM(where information are retrieved) and its artifact
file
+ then invoked the <<<install>>> phase of the default build lifecycle.
+
++---+
+mvn install
++---+
+
+* The <<<install:install-file>>> Mojo
+
+ The <<<install:install-file>>> mojo is used primarily for installing
artifacts to
+ which were not built by Maven. The project's development team may or may not
+ provide a POM for the artifact. The full usage statement of the install-file
+ mojo can be described as:
+
++---+
+mvn install:install-file -Dfile=your-artifact-1.0.jar \
+ [-DpomFile=your-pom.xml] \
+ [-DgroupId=org.some.group] \
+ [-DartifactId=your-artifact] \
+ [-Dversion=1.0] \
+ [-Dpackaging=jar] \
+ [-DgeneratePom=true]
+ [-DcreateChecksum=true]
++---+
+
+ * the group, artifact, version and packaging of the file to install. These
can
+ be taken from the specified pomFile, and overriden or specified using the
+ command line. When the pomFile contains a <parent> section, the parent's
+ groupId can be considered if the groupId is not specified further for the
+ current project or on the command line.
+
+
