Author: rfscholte
Date: Sat Jul 20 14:31:29 2013
New Revision: 1505143
URL: http://svn.apache.org/r1505143
Log:
[MINSTALL-95] Enhance documentation of install-file
Added:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt.vm
- copied, changed from r1501534,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt.vm
- copied, changed from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt.vm
- copied, changed from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt.vm
- copied, changed from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt.vm
- copied, changed from r1501534,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt
Removed:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt
Modified:
maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-install-plugin/src/site/site.xml
Copied:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt.vm
(from r1501534,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt.vm?p2=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt.vm&p1=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt&r1=1501534&r2=1505143&rev=1505143&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt.vm
Sat Jul 20 14:31:29 2013
@@ -33,5 +33,14 @@ Installing an artifact with a custom POM
to the path of the custom POM.
+---+
-mvn install:install-file -Dfile=path-to-your-artifact-jar -DpomFile=path-to-pom
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=path-to-your-artifact-jar -DpomFile=path-to-pom
+---+
+
+ If the JAR was built by Apache Maven, it'll contain a pom.xml in a subfolder
of the META-INF directory, which will be read by default. In that case, all you
need to do is:
+
++---+
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=<path-to-file>
++---+
+
+ <<Note>>: By using the fully qualified path of a goal, you're ensured to be
using the preferred version of the maven-install-plugin. When using <<<mvn
install:install-file>>>
+ its version depends on its specification in the pom or the version of Apache
Maven.
Copied:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt.vm
(from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt.vm?p2=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt.vm&p1=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt&r1=1501531&r2=1505143&rev=1505143&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt.vm
Sat Jul 20 14:31:29 2013
@@ -36,10 +36,13 @@ Generating a generic POM
<<<generatePom>>> parameter to <<<true>>>.
+---+
-mvn install:install-file -Dfile=path-to-your-artifact-jar \
- -DgroupId=your.groupId \
- -DartifactId=your-artifactId \
- -Dversion=version \
- -Dpackaging=jar \
- -DgeneratePom=true
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=path-to-your-artifact-jar \
+
-DgroupId=your.groupId \
+
-DartifactId=your-artifactId \
+
-Dversion=version \
+
-Dpackaging=jar \
+
-DgeneratePom=true
+---+
+
+ <<Note>>: By using the fully qualified path of a goal, you're ensured to be
using the preferred version of the maven-install-plugin. When using <<<mvn
install:install-file>>>
+ its version depends on its specification in the pom or the version of Apache
Maven.
Copied:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt.vm
(from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt.vm?p2=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt.vm&p1=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt&r1=1501531&r2=1505143&rev=1505143&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt.vm
Sat Jul 20 14:31:29 2013
@@ -43,10 +43,13 @@ mvn install -DcreateChecksum=true
In the <<<install:install-file>>> goal.
+---+
-mvn install:install-file -Dfile=path-to-your-artifact-jar \
- -DgroupId=your.groupId \
- -DartifactId=your-artifactId \
- -Dversion=version \
- -Dpackaging=jar \
- -DcreateChecksum=true
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=path-to-your-artifact-jar \
+
-DgroupId=your.groupId \
+
-DartifactId=your-artifactId \
+
-Dversion=version \
+
-Dpackaging=jar \
+
-DcreateChecksum=true
+---+
+
+ <<Note>>: By using the fully qualified path of a goal, you're ensured to be
using the preferred version of the maven-install-plugin. When using <<<mvn
install:install-file>>>
+ its version depends on its specification in the pom or the version of Apache
Maven.
Copied:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt.vm
(from r1501531,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt.vm?p2=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt.vm&p1=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt&r1=1501531&r2=1505143&rev=1505143&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-secondary-artifacts.apt.vm
Sat Jul 20 14:31:29 2013
@@ -40,10 +40,13 @@ Installing Secondary Artifacts
following command:
+---+
-mvn install:install-file -Dfile=path-to-commons-logging-sources.jar \
- -DgroupId=commons-logging \
- -DartifactId=commons-logging \
- -Dversion=1.0.3 \
- -Dpackaging=jar \
- -Dclassifier=sources
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=path-to-commons-logging-sources.jar \
+
-DgroupId=commons-logging \
+
-DartifactId=commons-logging \
+
-Dversion=1.0.3 \
+
-Dpackaging=jar \
+
-Dclassifier=sources
+---+
+
+ <<Note>>: By using the fully qualified path of a goal, you're ensured to be
using the preferred version of the maven-install-plugin. When using <<<mvn
install:install-file>>>
+ its version depends on its specification in the pom or the version of Apache
Maven.
Copied:
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt.vm
(from r1501534,
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt.vm?p2=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt.vm&p1=maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt&r1=1501534&r2=1505143&rev=1505143&view=diff
==============================================================================
---
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt
(original)
+++
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/specific-local-repo.apt.vm
Sat Jul 20 14:31:29 2013
@@ -2,8 +2,9 @@
Installing an artifact to a specific local repository path
------
Vincent Siveton
+ Robert Scholte
------
- 2009-03-22
+ 2013-07-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,16 +29,22 @@
Installing an artifact to a specific local repository path
- By default, the Apache Maven Install Plugin uses the local repository
defined in the settings.xml to install an artifact.
+ General information about how to copy jars into your local repository can be
found in the
+ {{{http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html}Guide
to installing 3rd party JARs}}
+
+ By default, the Apache Maven Install Plugin uses the local repository
defined in the <<<settings.xml>>> to install an artifact.
You could install an artifact on a specific local repository by setting the
<<<localRepositoryPath>>>
parameter when installing.
+---+
-mvn install:install-file -Dfile=path-to-your-artifact-jar \
- -DgroupId=your.groupId \
- -DartifactId=your-artifactId \
- -Dversion=version \
- -Dpackaging=jar \
- -DlocalRepositoryPath=path-to-specific-local-repo
+mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file
-Dfile=path-to-your-artifact-jar \
+
-DgroupId=your.groupId \
+
-DartifactId=your-artifactId \
+
-Dversion=version \
+
-Dpackaging=jar \
+
-DlocalRepositoryPath=path-to-specific-local-repo
+---+
+
+ <<Note>>: By using the fully qualified path of a goal, you're ensured to be
using the preferred version of the maven-install-plugin. When using <<<mvn
install:install-file>>>
+ its version depends on its specification in the pom or the version of Apache
Maven.
Modified: 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=1505143&r1=1505142&r2=1505143&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt Sat Jul 20
14:31:29 2013
@@ -2,8 +2,9 @@
Usage
------
Allan Ramirez
+ Robert Scholte
------
- 2009-03-13
+ 2013-07-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,6 +29,14 @@
Usage
+ Apache Maven has a two level strategy to resolve and distribute files, which
we call artifacts.
+ The first level is called the <<<local repository>>>, which is the artifact
cache on your system, by default located at <<<$\{user.home\}/.m2/repository>>>.
+ When executing Maven, it'll first look in this local cache for artifacts. If
the artifact cannot be found here, Maven will access the remote repositories to
find the artifact.
+ Once found it will be stored into the local repository, so it's be available
for current and future usage.
+
+ With the <<<maven-install-plugin>>> you can put your artifacts in the local
repository. To upload artifacts to a remote repository, you need to use the
+
{{{http://maven.apache.org/plugins/maven-deploy-plugin/}maven-deploy-plugin}}.
+
* The <<<install:install>>> goal
In most cases, <<<install:install>>> goal doesn't need any configuration, it
Modified: maven/plugins/trunk/maven-install-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/site.xml?rev=1505143&r1=1505142&r2=1505143&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/site.xml Sat Jul 20
14:31:29 2013
@@ -31,8 +31,8 @@ under the License.
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Installing a Custom POM"
href="examples/custom-pom-installation.html"/>
- <item name="Generating a Generic POM"
href="examples/generic-pom-generation.html"/>
+ <item name="Installing Artifact with Custom POM"
href="examples/custom-pom-installation.html"/>
+ <item name="Generating Generic POM"
href="examples/generic-pom-generation.html"/>
<item name="Creating Checksums"
href="examples/installing-checksums.html"/>
<item name="Updating Release Info"
href="examples/update-release-info.html"/>
<item name="Installing to a Specific Local Repository Path"
href="examples/specific-local-repo.html"/>
