You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2021/05/31 23:33:08 UTC

[maven-install-plugin] 01/01: clean up docs

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch gen
in repository https://gitbox.apache.org/repos/asf/maven-install-plugin.git

commit 35cda49e8108d5b548facbfb0bf135c084855bef
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Mon May 31 19:32:51 2021 -0400

    clean up docs
---
 src/site/apt/index.apt.vm | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index b1ed2a0..947beb3 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -42,9 +42,9 @@ ${project.name}
 
   The Install Plugin has 3 goals:
 
-  * {{{./install-mojo.html}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-mojo.html}install:install}} installs the
+    project's main artifact (the JAR, WAR or EAR), its POM, and any attached artifacts
+    (sources, javadoc, etc) produced by a particular project into the local repository.
 
   * {{{./install-file-mojo.html}install:install-file}} is mostly used to install an externally
     created artifact into the local repository, along with its POM. In that case
@@ -57,21 +57,21 @@ ${project.name}
 
 * Important Note for Version 3.0.0+
 
-  The {{{./install-mojo.html}install:install}} goal does not support creating checksums anymore
-  via <<<-DcreateChecksum=true>>> cause this option has been removed. Details can be found
-  in {{{https://issues.apache.org/jira/browse/MINSTALL-143}MINSTALL-143}}.
+  The {{{./install-mojo.html}install:install}} goal no longer supports creating checksums
+  via <<<-DcreateChecksum=true>>> because cause the checksums are only needed as a preparation
+  for the transfer to a remote repository but not for an installation into a local repository.
   
 * Usage
 
-  General instructions on how to use the Install Plugin can be found on the {{{./usage.html}usage page}}. Some more
-  specific use cases are described in the examples given below.
+  General instructions can be found on the {{{./usage.html}usage page}}. Some more
+  specific use cases are described in the examples below.
 
   In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
   free to contact the {{{./mailing-lists.html}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 {{{./mailing-lists.html}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
+  If you feel the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
   {{{./issue-management.html}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.