Return-Path: X-Original-To: apmail-maven-commits-archive@www.apache.org Delivered-To: apmail-maven-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id D3E4A10D32 for ; Mon, 9 Sep 2013 20:02:50 +0000 (UTC) Received: (qmail 87991 invoked by uid 500); 9 Sep 2013 20:02:50 -0000 Delivered-To: apmail-maven-commits-archive@maven.apache.org Received: (qmail 87933 invoked by uid 500); 9 Sep 2013 20:02:50 -0000 Mailing-List: contact commits-help@maven.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@maven.apache.org Delivered-To: mailing list commits@maven.apache.org Received: (qmail 87926 invoked by uid 99); 9 Sep 2013 20:02:50 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 09 Sep 2013 20:02:50 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 09 Sep 2013 20:02:39 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 9341F2388B46 for ; Mon, 9 Sep 2013 20:01:52 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r877833 [6/17] - in /websites/production/maven/content/plugins/maven-install-plugin: ./ apidocs/ apidocs/class-use/ apidocs/org/apache/maven/plugin/install/ apidocs/org/apache/maven/plugin/install/class-use/ cobertura/ examples/ testapidocs... Date: Mon, 09 Sep 2013 20:01:47 -0000 To: commits@maven.apache.org From: rfscholte@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130909200152.9341F2388B46@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: websites/production/maven/content/plugins/maven-install-plugin/findbugs.html ============================================================================== --- websites/production/maven/content/plugins/maven-install-plugin/findbugs.html (original) +++ websites/production/maven/content/plugins/maven-install-plugin/findbugs.html Mon Sep 9 20:01:45 2013 @@ -1,18 +1,18 @@ - Maven Install plugin - FindBugs Bug Detector Report + Apache Maven Install Plugin - FindBugs Bug Detector Report - + @@ -41,13 +41,13 @@ > Plugins > - Maven Install plugin + Apache Maven Install Plugin > FindBugs Bug Detector Report
- Last Published: 2012-10-26 -  | Version: 2.4 + Last Published: 2013-09-09 +  | Version: 2.5
@@ -74,10 +74,10 @@
Examples
Project Documentation
-

FindBugs Bug Detector Report

The following document contains the results of FindBugs Report

FindBugs Version is 2.0.1

Threshold is medium

Effort is min

Summary

ClassesBugsErrorsMissing Classes
4300

Files

ClassBugs
org.apache.maven.plugin.install.AbstractInstallMojo1
org.apache.maven.plugin.insta ll.HelpMojo1
org.apache.maven.plugin.install.InstallFileMojo1

org.apache.maven.plugin.install.AbstractInstallMojo

BugCategoryDetailsLinePriority
exceptional return value of java.io.File.mkdirs() ignored in org.apache.maven.plugin.install.AbstractInstallMojo.installChecksum(File, File, Digester, String)BAD_PRACTICERV_RETURN_VALUE_IGNORED_BAD_PRACTICE216 Medium

org.apache.maven.plugin.install.HelpMojo

BugCategoryDetailsLinePriority
Unwritten field: org.apache.maven.plugin.install.HelpMojo.goalCORRECTNESSUWF_UNWRITTEN_FIELD129Medium

org.apache.maven.plugin.install.InstallFileMojo

BugCategoryDetai lsLinePriority
exceptional return value of java.io.File.delete() ignored in org.apache.maven.plugin.install.InstallFileMojo.execute()BAD_PRACTICERV_RETURN_VALUE_IGNORED_BAD_PRACTICE268Medium
+
+

FindBugs Bug Detector Report

+

The following document contains the results of FindBugs Report

+

FindBugs Version is 2.0.1

+

Threshold is medium

+

Effort is min

+
+

Summary

+ + + + + + + + + + +
ClassesBugsErrorsMissing Classes
5400
+
+

Files

+ + + + + + + + + + + + +
ClassBugs
org.apache.maven.plugin.install.AbstractInstallMojo1
org.apache.maven.plugin.install.HelpMojo1
org.apache.maven.plugin.install.InstallFileMojo2
+
+

org.apache.maven.plugin.install.AbstractInstallMojo

+ + + + + + + + + + + + +
BugCategoryDetailsLinePriority
exceptional return value of java.io.File.mkdirs() ignored in org.apache.maven.plugin.install.AbstractInstallMojo.installChecksum(File, String, String)BAD_PRACTICERV_RETURN_VALUE_IGNORED_BAD_PRACTICE198Medium
+
+

org.apache.maven.plugin.install.HelpMojo

+ + + + + + + + + + + + +
BugCategoryDetailsLinePriority
org.apache.maven.plugin.install.HelpMojo.build() may fail to clean up java.io.InputStreamEXPERIMENTALOBL_UNSATISFIED_OBLIGATION68Medium
+
+

org.apache.maven.plugin.install.InstallFileMojo

+ + + + + + + + + + + + + + + + + + +
BugCategoryDetailsLinePriority
org.apache.maven.plugin.install.InstallFileMojo.execute() may fail to close streamBAD_PRACTICEOS_OPEN_STREAM225Medium
exceptional return value of java.io.File.delete() ignored in org.apache.maven.plugin.install.InstallFileMojo.execute()BAD_PRACTICERV_RETURN_VALUE_IGNORED_BAD_PRACTICE334Medium
Modified: websites/production/maven/content/plugins/maven-install-plugin/help-mojo.html ============================================================================== --- websites/production/maven/content/plugins/maven-install-plugin/help-mojo.html (original) +++ websites/production/maven/content/plugins/maven-install-plugin/help-mojo.html Mon Sep 9 20:01:45 2013 @@ -1,11 +1,11 @@ - Maven Install plugin - + <title>Apache Maven Install Plugin - install:help - + @@ -42,14 +42,14 @@ > Plugins > - Maven Install plugin + Apache Maven Install Plugin > install:help
- Last Published: 2012-10-26 -  | Version: 2.4 + Last Published: 2013-09-09 +  | Version: 2.5
@@ -76,10 +76,10 @@
Examples
Project Documentation
@@ -124,9 +124,15 @@ Maven 2 & 3
  • + Parent POMs +
    • +
  • Plugins
  • + Plugin Tools +
    • +
  • SCM
  • @@ -167,83 +173,148 @@
    -

    install:help

    -

    Full name:

    -

    org.apache.maven.plugins:maven-install-plugin:2.4:help

    -

    Description:

    -
    Display help information on maven-install-plugin.
    +
    +

    install:help

    + +

    Full name:

    + +

    org.apache.maven.plugins:maven-install-plugin:2.5:help

    + +

    Description:

    + +
    Display help information on maven-install-plugin.
    Call mvn install:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
    -

    Attributes:

    -
      -
    • The goal is thread-safe and supports parallel builds.
      • + +

      Attributes:

      + +
        + +
      • The goal is thread-safe and supports parallel builds.
      -

      Optional Parameters

      - - - - - - + +
      +

      Optional Parameters

      + +
      NameTypeSinceDescription
      + + + + + + + + + + - - - - - + + + + + + + + - - - - - + + + + + + + + - - - - - + + + + + + + + + + - - - - - + + + + + + + + + +
      NameTypeSinceDescription
      detailboolean-If true, display all settable properties for each + +
      detailboolean-If true, display all settable properties for each goal.
      Default value is: false.
      User property is: detail.
      goalString-The name of the goal for which to show help. If unspecified, all + +
      goalString-The name of the goal for which to show help. If unspecified, all goals will be displayed.
      User property is: goal.
      indentSizeint-The number of spaces per indentation level, should be positive.
      Default value is: 2.
      User property is: indentSize.
      indentSizeint-The number of spaces per indentation level, should be positive.
      Default value is: 2.
      User property is: indentSize.
      lineLengthint-The maximum length of a display line, should be positive.
      Default value is: 80.
      User property is: lineLength.
      lineLengthint-The maximum length of a display line, should be positive.
      Default value is: 80.
      User property is: lineLength.
      -

      Parameter Details

      -

      detail:

      -
      If true, display all settable properties for each + +
      +

      Parameter Details

      + +

      detail:

      + +
      If true, display all settable properties for each goal.
      -
        -
      • Type: boolean
        • -
      • Required: No
        • -
      • User Property: detail
        • -
      • Default: false
        • -

      goal:

      -
      The name of the goal for which to show help. If unspecified, all + +
        + +
      • Type: boolean
        • + +
      • Required: No
        • + +
      • User Property: detail
        • + +
      • Default: false
        • +
      +

      goal:

      + +
      The name of the goal for which to show help. If unspecified, all goals will be displayed.
      -
        -
      • Type: java.lang.String
        • -
      • Required: No
        • -
      • User Property: goal
        • -

      indentSize:

      -
      The number of spaces per indentation level, should be positive.
      -
        -
      • Type: int
        • -
      • Required: No
        • -
      • User Property: indentSize
        • -
      • Default: 2
        • -

      lineLength:

      -
      The maximum length of a display line, should be positive.
      -
        -
      • Type: int
        • -
      • Required: No
        • -
      • User Property: lineLength
        • -
      • Default: 80
        • + +
          + +
        • Type: java.lang.String
          • + +
        • Required: No
          • + +
        • User Property: goal
          • +
        +

        indentSize:

        + +
        The number of spaces per indentation level, should be positive.
        + +
          + +
        • Type: int
          • + +
        • Required: No
          • + +
        • User Property: indentSize
          • + +
        • Default: 2
          • +
        +

        lineLength:

        + +
        The maximum length of a display line, should be positive.
        + +
          + +
        • Type: int
          • + +
        • Required: No
          • + +
        • User Property: lineLength
          • + +
        • Default: 80
      Modified: websites/production/maven/content/plugins/maven-install-plugin/index.html ============================================================================== --- websites/production/maven/content/plugins/maven-install-plugin/index.html (original) +++ websites/production/maven/content/plugins/maven-install-plugin/index.html Mon Sep 9 20:01:45 2013 @@ -1,11 +1,11 @@ - Maven Install plugin - Introduction + Apache Maven Install Plugin - Introduction - - + + @@ -43,13 +43,13 @@ > Plugins > - Maven Install plugin + Apache Maven Install Plugin > Introduction
      - Last Published: 2012-10-26 -  | Version: 2.4 + Last Published: 2013-09-06 +  | Version: 2.5
      @@ -76,10 +76,10 @@
      Examples
      Project Documentation
      @@ -165,9 +168,15 @@ Maven 2 & 3
    • + Parent POMs +
      • +
    • Plugins
    • + Plugin Tools +
      • +
    • SCM
    • @@ -206,7 +215,32 @@
      • -

      Maven Install Plugin

      The Install Plugin is used during the install phase to add artifact(s) to the local repository. The Install Plugin uses the information in the POM (groupId, artifactId, version) to determine the proper location for the artifact within the local repository.

      The local repository is the local cache where all artifacts needed for the build are stored. By default, it is located within the user's home directory (~/.m2/repository) but the location can be configured in ~/.m2/settings.xml using the <localRepository> element.

      Goals Overview

      The Install Plugin has 3 goals:

      • install:install is used to automatically install the project's main artifact (the JAR, WAR or EAR), its POM and any attached artifacts (sources, javadoc, etc) produced by a particular project.
      • install:install-file is mostly used to install an externally created artifact into the local repository, along with its POM. In that case the project information can be taken from an optionally specified pomFile, but can also be given using command line parameters.
      • install:help displays help information on maven-install-plugin.

      Usage

      General instructions on how to use the Install Plugin can be found on the usage page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's wiki page.

      In case you still have questions regarding the plugin's usage, please have a look at t he FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

      If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in t he guide to helping with Maven.

      Examples

      To provide you with better understanding on some usages of the Maven Install Plugin, you can take a look into the following examples:

      +
      +

      Apache Maven Install Plugin

      +

      The Install Plugin is used during the install phase to add artifact(s) to the local repository. The Install Plugin uses the information in the POM (groupId, artifactId, version) to determine the proper location for the artifact within the local repository.

      +

      The local repository is the local cache where all artifacts needed for the build are stored. By default, it is located within the user's home directory (~/.m2/repository) but the location can be configured in ~/.m2/settings.xml using the <localRepository> element.

      +
      +

      Goals Overview

      +

      The Install Plugin has 3 goals:

      +
        +
      • install:install is used to automatically install the project's main artifact (the JAR, WAR or EAR), its POM and any attached artifacts (sources, javadoc, etc) produced by a particular project.
        • +
      • install:install-file is mostly used to install an externally created artifact into the local repository, along with its POM. In that case the project information can be taken from an optionally specified pomFile, but can also be given using command line parameters.
        • +
      • install:help displays help information on maven-install-plugin.
      +
      +

      Usage

      +

      General instructions on how to use the Install Plugin can be found on the usage page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's wiki page.

      +

      In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

      +

      If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

      +
      +

      Examples

      +

      To provide you with better understanding on some usages of the Maven Install Plugin, you can take a look into the following examples:

      +
      Modified: websites/production/maven/content/plugins/maven-install-plugin/install-file-mojo.html ============================================================================== --- websites/production/maven/content/plugins/maven-install-plugin/install-file-mojo.html (original) +++ websites/production/maven/content/plugins/maven-install-plugin/install-file-mojo.html Mon Sep 9 20:01:45 2013 @@ -1,11 +1,11 @@ - Maven Install plugin - + <title>Apache Maven Install Plugin - install:install-file - + @@ -42,14 +42,14 @@ > Plugins > - Maven Install plugin + Apache Maven Install Plugin > install:install-file
      - Last Published: 2012-10-26 -  | Version: 2.4 + Last Published: 2013-09-09 +  | Version: 2.5
      @@ -76,10 +76,10 @@
      Examples
      Project Documentation
      @@ -124,9 +124,15 @@ Maven 2 & 3
    • + Parent POMs +
      • +
    • Plugins
    • + Plugin Tools +
      • +
    • SCM
    • @@ -167,242 +173,442 @@
      -

      install:install-file

      -

      Full name:

      -

      org.apache.maven.plugins:maven-install-plugin:2.4:install-file

      -

      Description:

      -
      Installs a file in the local repository.
      -

      Attributes:

      -
        -
      • Executes as an aggregator plugin.
        • -
      • The goal is thread-safe and supports parallel builds.
        • +
        +

        install:install-file

        + +

        Full name:

        + +

        org.apache.maven.plugins:maven-install-plugin:2.5:install-file

        + +

        Description:

        + +
        Installs a file in the local repository.
        + +

        Attributes:

        + +
          + +
        • Executes as an aggregator plugin.
          • + +
        • The goal is thread-safe and supports parallel builds.
        -

        Required Parameters

        - - - - - - - - - - - - - - - - - -
        NameTypeSinceDescription
        fileFile-The file to be installed in the local repository.
        User property is: file.
        repositoryLayoutString2.2The type of remote repository layout to install to. Try + +
        +

        Required Parameters

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        NameTypeSinceDescription
        fileFile-The file to be installed in the local repository.
        User property is: file.
        repositoryLayoutString2.2The type of remote repository layout to install to. Try legacy for a Maven 1.x-style repository layout.
        Default value is: default.
        User property is: repositoryLayout.
        -

        Optional Parameters

        - - - - - - - - - - - - - - - - - -
        NameTypeSinceDescription
        artifactIdString-ArtifactId of the artifact to be installed. Retrieved from POM file -if one is specified.
        User property is: artifactId.
        classifierString2.2Classifier type of the artifact to be installed. For example, + +
        +

        Optional Parameters

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + + + +
        NameTypeSinceDescription
        artifactIdString-ArtifactId of the artifact to be installed. Retrieved from POM file +if one is specified or extracted from pom.xml in jar +if available.
        User property is: artifactId.
        classifierString2.2Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
        User property is: classifier.
        createChecksumboolean2.2Flag whether to create checksums (MD5, SHA-1) or not.
        Default value is: false.
        User property is: createChecksum.
        generatePomBoolean2.1Generate a minimal POM for the artifact if none is supplied via the + +
        createChecksumboolean2.2Flag whether to create checksums (MD5, SHA-1) or not.
        Default value is: false.
        User property is: createChecksum.
        generatePomBoolean2.1Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
        User property is: generatePom.
        groupIdString-GroupId of the artifact to be installed. Retrieved from POM file if -one is specified.
        User property is: groupId.
        javadocFile2.3The bundled API docs for the artifact.
        User property is: javadoc.
        localRepositoryPathFile2.2The path for a specific local repository directory. If not + +
        groupIdString-GroupId of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from pom.xml in jar if +available.
        User property is: groupId.
        javadocFile2.3The bundled API docs for the artifact.
        User property is: javadoc.
        localRepositoryPathFile2.2The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
        User property is: localRepositoryPath.
        packagingString-Packaging type of the artifact to be installed. Retrieved from POM -file if one is specified.
        User property is: packaging.
        pomFileFile2.1Location of an existing POM file to be installed alongside the main + +
        packagingString-Packaging type of the artifact to be installed. Retrieved from POM +file if one is specified or extracted from pom.xml in +jar if available.
        User property is: packaging.
        pomFileFile2.1Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
        User property is: pomFile.
        sourcesFile2.3The bundled sources for the artifact.
        User property is: sources.
        updateReleaseInfoboolean-Whether to update the metadata to make the artifact a release + +
        sourcesFile2.3The bundled sources for the artifact.
        User property is: sources.
        updateReleaseInfoboolean-Whether to update the metadata to make the artifact a release version.
        Default value is: false.
        User property is: updateReleaseInfo.
        versionString-Version of the artifact to be installed. Retrieved from POM file if -one is specified.
        User property is: version.
        versionString-Version of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from pom.xml in jar if +available.
        User property is: version.
        -

        Parameter Details

        -

        artifactId:

        -
        ArtifactId of the artifact to be installed. Retrieved from POM file -if one is specified.
        -
          -
        • Type: java.lang.String
          • -
        • Required: No
          • -
        • User Property: artifactId
          • -

        classifier:

        -
        Classifier type of the artifact to be installed. For example, + +
        +

        Parameter Details

        + +

        artifactId:

        + +
        ArtifactId of the artifact to be installed. Retrieved from POM file +if one is specified or extracted from pom.xml in jar +if available.
        + +
          + +
        • Type: java.lang.String
          • + +
        • Required: No
          • + +
        • User Property: artifactId
          • +
        +

        classifier:

        + +
        Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
        -
          -
        • Type: java.lang.String
          • -
        • Since: 2.2
          • -
        • Required: No
          • -
        • User Property: classifier
          • -

        createChecksum:

        -
        Flag whether to create checksums (MD5, SHA-1) or not.
        -
          -
        • Type: boolean
          • -
        • Since: 2.2
          • -
        • Required: No
          • -
        • User Property: createChecksum
          • -
        • Default: false
          • -

        file:

        -
        The file to be installed in the local repository.
        -
          -
        • Type: java.io.File
          • -
        • Required: Yes
          • -
        • User Property: file
          • -

        generatePom:

        -
        Generate a minimal POM for the artifact if none is supplied via the + +
          + +
        • Type: java.lang.String
          • + +
        • Since: 2.2
          • + +
        • Required: No
          • + +
        • User Property: classifier
          • +
        +

        createChecksum:

        + +
        Flag whether to create checksums (MD5, SHA-1) or not.
        + +
          + +
        • Type: boolean
          • + +
        • Since: 2.2
          • + +
        • Required: No
          • + +
        • User Property: createChecksum
          • + +
        • Default: false
          • +
        +

        file:

        + +
        The file to be installed in the local repository.
        + +
          + +
        • Type: java.io.File
          • + +
        • Required: Yes
          • + +
        • User Property: file
          • +
        +

        generatePom:

        + +
        Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
        -
          -
        • Type: java.lang.Boolean
          • -
        • Since: 2.1
          • -
        • Required: No
          • -
        • User Property: generatePom
          • -

        groupId:

        -
        GroupId of the artifact to be installed. Retrieved from POM file if -one is specified.
        -
          -
        • Type: java.lang.String
          • -
        • Required: No
          • -
        • User Property: groupId
          • -

        javadoc:

        -
        The bundled API docs for the artifact.
        -
          -
        • Type: java.io.File
          • -
        • Since: 2.3
          • -
        • Required: No
          • -
        • User Property: javadoc
          • -

        localRepositoryPath:

        -
        The path for a specific local repository directory. If not + +
          + +
        • Type: java.lang.Boolean
          • + +
        • Since: 2.1
          • + +
        • Required: No
          • + +
        • User Property: generatePom
          • +
        +

        groupId:

        + +
        GroupId of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from pom.xml in jar if +available.
        + +
          + +
        • Type: java.lang.String
          • + +
        • Required: No
          • + +
        • User Property: groupId
          • +
        +

        javadoc:

        + +
        The bundled API docs for the artifact.
        + +
          + +
        • Type: java.io.File
          • + +
        • Since: 2.3
          • + +
        • Required: No
          • + +
        • User Property: javadoc
          • +
        +

        localRepositoryPath:

        + +
        The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
        -
          -
        • Type: java.io.File
          • -
        • Since: 2.2
          • -
        • Required: No
          • -
        • User Property: localRepositoryPath
          • -

        packaging:

        -
        Packaging type of the artifact to be installed. Retrieved from POM -file if one is specified.
        -
          -
        • Type: java.lang.String
          • -
        • Required: No
          • -
        • User Property: packaging
          • -

        pomFile:

        -
        Location of an existing POM file to be installed alongside the main + +
          + +
        • Type: java.io.File
          • + +
        • Since: 2.2
          • + +
        • Required: No
          • + +
        • User Property: localRepositoryPath
          • +
        +

        packaging:

        + +
        Packaging type of the artifact to be installed. Retrieved from POM +file if one is specified or extracted from pom.xml in +jar if available.
        + +
          + +
        • Type: java.lang.String
          • + +
        • Required: No
          • + +
        • User Property: packaging
          • +
        +

        pomFile:

        + +
        Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
        -
          -
        • Type: java.io.File
          • -
        • Since: 2.1
          • -
        • Required: No
          • -
        • User Property: pomFile
          • -

        repositoryLayout:

        -
        The type of remote repository layout to install to. Try + +
          + +
        • Type: java.io.File
          • + +
        • Since: 2.1
          • + +
        • Required: No
          • + +
        • User Property: pomFile
          • +
        +

        repositoryLayout:

        + +
        The type of remote repository layout to install to. Try legacy for a Maven 1.x-style repository layout.
        -
          -
        • Type: java.lang.String
          • -
        • Since: 2.2
          • -
        • Required: Yes
          • -
        • User Property: repositoryLayout
          • -
        • Default: default
          • -

        sources:

        -
        The bundled sources for the artifact.
        -
          -
        • Type: java.io.File
          • -
        • Since: 2.3
          • -
        • Required: No
          • -
        • User Property: sources
          • -

        updateReleaseInfo:

        -
        Whether to update the metadata to make the artifact a release + +
          + +
        • Type: java.lang.String
          • + +
        • Since: 2.2
          • + +
        • Required: Yes
          • + +
        • User Property: repositoryLayout
          • + +
        • Default: default
          • +
        +

        sources:

        + +
        The bundled sources for the artifact.
        + +
          + +
        • Type: java.io.File
          • + +
        • Since: 2.3
          • + +
        • Required: No
          • + +
        • User Property: sources
          • +
        +

        updateReleaseInfo:

        + +
        Whether to update the metadata to make the artifact a release version.
        -
          -
        • Type: boolean
          • -
        • Required: No
          • -
        • User Property: updateReleaseInfo
          • -
        • Default: false
          • -

        version:

        -
        Version of the artifact to be installed. Retrieved from POM file if -one is specified.
        -
          -
        • Type: java.lang.String
          • -
        • Required: No
          • -
        • User Property: version
          • + +
            + +
          • Type: boolean
            • + +
          • Required: No
            • + +
          • User Property: updateReleaseInfo
            • + +
          • Default: false
            • +
          +

          version:

          + +
          Version of the artifact to be installed. Retrieved from POM file if +one is specified or extracted from pom.xml in jar if +available.
          + +
            + +
          • Type: java.lang.String
            • + +
          • Required: No
            • + +
          • User Property: version
        Modified: websites/production/maven/content/plugins/maven-install-plugin/install-mojo.html ============================================================================== --- websites/production/maven/content/plugins/maven-install-plugin/install-mojo.html (original) +++ websites/production/maven/content/plugins/maven-install-plugin/install-mojo.html Mon Sep 9 20:01:45 2013 @@ -1,11 +1,11 @@ - Maven Install plugin - + <title>Apache Maven Install Plugin - install:install - + @@ -42,14 +42,14 @@ > Plugins > - Maven Install plugin + Apache Maven Install Plugin > install:install
        - Last Published: 2012-10-26 -  | Version: 2.4 + Last Published: 2013-09-09 +  | Version: 2.5
        @@ -76,10 +76,10 @@
        Examples
        Project Documentation
        @@ -124,9 +124,15 @@ Maven 2 & 3
      • + Parent POMs +
        • +
      • Plugins
      • + Plugin Tools +
        • +
      • SCM
      • @@ -167,87 +173,168 @@
        -

        install:install

        -

        Full name:

        -

        org.apache.maven.plugins:maven-install-plugin:2.4:install

        -

        Description:

        -
        Installs the project's main artifact, and any other artifacts +
        +

        install:install

        + +

        Full name:

        + +

        org.apache.maven.plugins:maven-install-plugin:2.5:install

        + +

        Description:

        + +
        Installs the project's main artifact, and any other artifacts attached by other plugins in the lifecycle, to the local repository.
        -

        Attributes:

        -
          -
        • Requires a Maven project to be executed.
          • -
        • The goal is thread-safe and supports parallel builds.
          • -
        • Binds by default to the lifecycle phase: install.
          • + +

          Attributes:

          + +
            + +
          • Requires a Maven project to be executed.
            • + +
          • The goal is thread-safe and supports parallel builds.
            • + +
          • Binds by default to the lifecycle phase: install.
          -

          Required Parameters

          - - - - - - + +
          +

          Optional Parameters

          + +
          NameTypeSinceDescription
          + + + + + + + + + + - - - - - + + + + + + + + + + -
          NameTypeSinceDescription
          skipboolean2.4Set this to true to bypass artifact installation. Use -this for artifacts that does not need to be installed in the local -repository.
          Default value is: false.
          User property is: maven.install.skip.
          createChecksumboolean2.2Flag whether to create checksums (MD5, SHA-1) or not.
          Default value is: false.
          User property is: createChecksum.
          -
          -

          Optional Parameters

          - - - - - - + + + + + + + + + + - - - - - + + + + + + + + + + - - - - - + + + + + + + +
          NameTypeSinceDescription
          installAtEndboolean2.5Whether every project should be deployed during its own +deploy-phase or at the end of the multimodule build. If set to +true and the build fails, none of the reactor projects +is deployed
          Default value is: false.
          User property is: installAtEnd.
          createChecksumboolean2.2Flag whether to create checksums (MD5, SHA-1) or not.
          Default value is: false.
          User property is: createChecksum.
          skipboolean2.4Set this to true to bypass artifact installation. Use +this for artifacts that does not need to be installed in the local +repository.
          Default value is: false.
          User property is: maven.install.skip.
          updateReleaseInfoboolean-Whether to update the metadata to make the artifact a release + +
          updateReleaseInfoboolean-Whether to update the metadata to make the artifact a release version.
          Default value is: false.
          User property is: updateReleaseInfo.
          -

          Parameter Details

          -

          createChecksum:

          -
          Flag whether to create checksums (MD5, SHA-1) or not.
          -
            -
          • Type: boolean
            • -
          • Since: 2.2
            • -
          • Required: No
            • -
          • User Property: createChecksum
            • -
          • Default: false
            • -

          skip:

          -
          Set this to true to bypass artifact installation. Use + +
          +

          Parameter Details

          + +

          createChecksum:

          + +
          Flag whether to create checksums (MD5, SHA-1) or not.
          + +
            + +
          • Type: boolean
            • + +
          • Since: 2.2
            • + +
          • Required: No
            • + +
          • User Property: createChecksum
            • + +
          • Default: false
            • +
          +

          installAtEnd:

          + +
          Whether every project should be deployed during its own +deploy-phase or at the end of the multimodule build. If set to +true and the build fails, none of the reactor projects +is deployed
          + +
            + +
          • Type: boolean
            • + +
          • Since: 2.5
            • + +
          • Required: No
            • + +
          • User Property: installAtEnd
            • + +
          • Default: false
            • +
          +

          skip:

          + +
          Set this to true to bypass artifact installation. Use this for artifacts that does not need to be installed in the local repository.
          -
            -
          • Type: boolean
            • -
          • Since: 2.4
            • -
          • Required: Yes
            • -
          • User Property: maven.install.skip
            • -
          • Default: false
            • -

          updateReleaseInfo:

          -
          Whether to update the metadata to make the artifact a release + +
            + +
          • Type: boolean
            • + +
          • Since: 2.4
            • + +
          • Required: No
            • + +
          • User Property: maven.install.skip
            • + +
          • Default: false
            • +
          +

          updateReleaseInfo:

          + +
          Whether to update the metadata to make the artifact a release version.
          -
            -
          • Type: boolean
            • -
          • Required: No
            • -
          • User Property: updateReleaseInfo
            • -
          • Default: false
            • + +
              + +
            • Type: boolean
              • + +
            • Required: No
              • + +
            • User Property: updateReleaseInfo
              • + +
            • Default: false