You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2021/10/24 09:26:40 UTC
[maven-wrapper-plugin] branch master updated: improve
documentation: add links to Wrapper and Wrapper Distribution
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 0aeafcd improve documentation: add links to Wrapper and Wrapper Distribution
0aeafcd is described below
commit 0aeafcd8097d733c4302da9ad406e0a08d91b645
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Oct 24 11:25:54 2021 +0200
improve documentation: add links to Wrapper and Wrapper Distribution
---
src/site/markdown/index.md.vm | 4 ++--
src/site/markdown/usage.md | 18 ++++++++++--------
src/site/site.xml | 5 +++++
3 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index 5751639..29bcac0 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -18,8 +18,8 @@ specific language governing permissions and limitations
under the License.
-->
-The Apache Maven Wrapper Plugin helps with downloading and unpacking the wrapper distribution
- as introduced in Apache Maven 4
+The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](/ref/4-LATEST/apache-maven-wrapper/)
+as introduced in Apache Maven 4.
Goals Overview
--------------
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index f7f6a35..3c147fa 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -20,27 +20,29 @@ under the License.
Wrapper scripts are a set of files that can be added to your Maven project.
If people want to build this project, they don't need to install Maven first.
-Instead they can call the maven wrapper script, which will download and unpack Maven into their `${user.home}/.m2/wrapper/dists` folder.
-It is also a way to let every build the project with the same Maven version.
+Instead they can call the Maven wrapper script (like `mvnw`/`mvnw.cmd`), which will download and unpack Maven into their `${user.home}/.m2/wrapper/dists` folder.
+It is also an easy way to let everyone build the project with the same Maven version.
The Apache Maven Wrapper Plugin makes it easier to add these wrapper scripts to your project.
The scripts work like this:
-- download the maven-wrapper jar, if it is not available yet.
+- download the maven-wrapper jar, if it is not available yet,
- the wrapper-jar contains the code to download and run Apache Maven
-Types
+Apache Maven Wrapper Distribution Types
-----
-There are 3 types available
+Wrapper scripts are provided by Maven 4 releases as ["Apache Maven Wrapper Distribution"](/ref/4-LATEST/apache-maven-wrapper/).
-- **Script** _(default)_: With this type the scripts will try to download the scripts via wget or curl in case of Unix based system, or use Powershell in case of Windows
+There are 3 types available:
+- **script** _(default)_: With this type the scripts will try to download the scripts via wget or curl in case of Unix based system, or use Powershell in case of Windows
-- **Bin**: With this type the maven-wrapper jar is already available in the `.mvn/wrapper` folder, so you don't have to rely on wget/curl or Powershell
+
+- **bin**: With this type the maven-wrapper jar is already available in the `.mvn/wrapper` folder, so you don't have to rely on wget/curl or Powershell
The downside is that the project will contain a binary file in the source control management system.
-- **Source**: Since Maven already requires Java to run, why not compile and run a classfile to download the maven-wrapper jar?
+- **source**: Since Maven already requires Java to run, why not compile and run a classfile to download the maven-wrapper jar?
This type comes with a `.mvn/wrapper/MavenWrapperDownloader.java` which will be compiled and executed on the fly.
Maven Version
diff --git a/src/site/site.xml b/src/site/site.xml
index 9b32692..3b846b6 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -31,5 +31,10 @@ under the License.
<item name="License" href="http://www.apache.org/licenses/"/>
<item name="Download" href="download.html"/>
</menu>
+
+ <menu name="Reference">
+ <item name="Wrapper Distribution" href="/ref/4-LATEST/apache-maven-wrapper/"/>
+ <item name="Wrapper" href="/ref/4-LATEST/maven-wrapper/"/>
+ </menu>
</body>
</project>