Skip to content
This repository was archived by the owner on Jan 19, 2022. It is now read-only.

Commit 0d84a89

Browse files
hboutemyhboutemy
committed
[MWRAPPER-14] update documentation
1 parent 5e71ecd commit 0d84a89

File tree

12 files changed

+93
-48
lines changed

12 files changed

+93
-48
lines changed

‎maven-wrapper-distribution/src/site/apt/index.apt.vm‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ mvnwDebug.cmd
5555

5656
[]
5757

58-
Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{/plugins/maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
58+
Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{../maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.

‎maven-wrapper-distribution/src/site/site.xml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ under the License.
2121

2222
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2323
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
24-
25-
<edit>${project.scm.url}</edit>
26-
2724
<body>
2825
<menu ref="parent"/>
2926
<menu ref="reports"/>

‎maven-wrapper-plugin/src/site/markdown/index.md.vm‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ specific language governing permissions and limitations
1818
under the License.
1919
-->
2020

21-
The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](/ref/4-LATEST/apache-maven-wrapper/)
22-
as introduced in Apache Maven 4.
21+
The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](../maven-wrapper-distribution/).
2322

2423
Goals Overview
2524
--------------
2625

2726

2827
* [wrapper:wrapper](./wrapper-mojo.html) is the default goal invoked during the
29-
`wrapper` phase. It downloads and unpacks the apache-maven-wrapper distribution,
28+
`wrapper` phase. It downloads and unpacks the maven-wrapper distribution,
3029

3130
Usage
3231
-----

‎maven-wrapper-plugin/src/site/markdown/usage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ This type comes with a `.mvn/wrapper/MavenWrapperDownloader.java` which will be
4848
Maven Version
4949
-------------
5050
By default the plugin will assume the same version as the Maven runtime (calling `mvn -v`). But you can pick a different version.
51-
Either call `mvn wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven
51+
Either call `mvn wrapper:wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven
5252
Another option is adjust the `distributionUrl` in `.mvn/wrapper/maven-wrapper.properties`
5353

5454
Debugging
5555
---------
5656

5757
The apache-maven-wrapper distributions all contains the `mvnwDebug`-script for both Windows and Unix based operating systems.
5858
This makes it possible to debug through Apache Maven, Maven Plugin or Maven Extension.
59-
You can exclude these scripts by calling `mvn wrapper -DincludeDebug=false`
59+
You can exclude these scripts by calling `mvn wrapper:wrapper -DincludeDebug=false`

‎maven-wrapper-plugin/src/site/site.xml‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,8 @@ under the License.
2727
<item name="Introduction" href="index.html"/>
2828
<item name="Goals" href="plugin-info.html"/>
2929
<item name="Usage" href="usage.html"/>
30-
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
31-
<item name="License" href="http://www.apache.org/licenses/"/>
32-
<item name="Download" href="download.html"/>
33-
</menu>
34-
35-
<menu name="Reference">
36-
<item name="Wrapper Distribution" href="/ref/4-LATEST/apache-maven-wrapper/"/>
37-
<item name="Wrapper" href="/ref/4-LATEST/maven-wrapper/"/>
3830
</menu>
31+
<menu ref="parent"/>
32+
<menu ref="reports"/>
3933
</body>
4034
</project>

‎maven-wrapper/src/site/apt/index.apt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@
2525

2626
Maven Wrapper
2727

28-
Maven Wrapper dowloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default.
28+
Maven Wrapper downloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default.
2929

30-
Maven Wrapper is called by {{{../apache-maven-wrapper/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.
30+
Maven Wrapper is called by {{{../maven-wrapper-distribution/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.

‎maven-wrapper/src/site/site.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ under the License.
2222
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2323
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
2424

25-
<edit>${project.scm.url}</edit>
26-
2725
<body>
2826
<menu name="Overview">
2927
<item name="Introduction" href="index.html"/>

‎pom.xml‎

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ under the License.
4040
</description>
4141
<inceptionYear>2020</inceptionYear>
4242

43-
<prerequisites>
44-
<maven>${mavenVersion}</maven>
45-
</prerequisites>
46-
4743
<scm>
4844
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</connection>
4945
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</developerConnection>
@@ -66,6 +62,7 @@ under the License.
6662
</distributionManagement>
6763

6864
<properties>
65+
<maven.site.path>wrapper-archives/wrapper-LATEST</maven.site.path>
6966
<mavenVersion>3.1.0</mavenVersion>
7067
<javaVersion>8</javaVersion>
7168
<project.build.outputTimestamp>2021-04-05T14:15:37Z</project.build.outputTimestamp>
@@ -76,21 +73,4 @@ under the License.
7673
<module>maven-wrapper-distribution</module>
7774
<module>maven-wrapper-plugin</module>
7875
</modules>
79-
80-
<build>
81-
<pluginManagement>
82-
<plugins>
83-
<plugin>
84-
<groupId>org.apache.maven.plugins</groupId>
85-
<artifactId>maven-jxr-plugin</artifactId>
86-
<version>3.0.0</version>
87-
</plugin>
88-
<plugin>
89-
<groupId>org.apache.maven.plugins</groupId>
90-
<artifactId>maven-project-info-reports-plugin</artifactId>
91-
<version>3.1.0</version>
92-
</plugin>
93-
</plugins>
94-
</pluginManagement>
95-
</build>
9676
</project>

‎src/site/apt/index.apt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
~~ Licensed to the Apache Software Foundation (ASF) under one
2+
~~ or more contributor license agreements. See the NOTICE file
3+
~~ distributed with this work for additional information
4+
~~ regarding copyright ownership. The ASF licenses this file
5+
~~ to you under the Apache License, Version 2.0 (the
6+
~~ "License"); you may not use this file except in compliance
7+
~~ with the License. You may obtain a copy of the License at
8+
~~
9+
~~ http://www.apache.org/licenses/LICENSE-2.0
10+
~~
11+
~~ Unless required by applicable law or agreed to in writing,
12+
~~ software distributed under the License is distributed on an
13+
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
~~ KIND, either express or implied. See the License for the
15+
~~ specific language governing permissions and limitations
16+
~~ under the License.
17+
18+
-----
19+
Introduction
20+
-----
21+
Hervé Boutemy
22+
-----
23+
2021-04-05
24+
-----
25+
26+
Maven Wrapper
27+
28+
Maven Wrapper is composed of 3 pieces:
29+
30+
- {{{./maven-wrapper/} maven-wrapper}},
31+
32+
- {{{./maven-wrapper-distribution/} maven-wrapper distribution}}, that provides <<<mvnw>>>:<<<mvnw.cmd>>> scripts distributions,
33+
34+
- {{{./maven-wrapper-plugin/} maven-wrapper-plugin}}, a plugin to ease installing Wrapper into a project.
35+

‎maven-wrapper-plugin/src/site/resources/download.cgi‎ renamed to ‎src/site/resources/download.cgi‎

File renamed without changes.

0 commit comments

Comments
 (0)