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/11/07 20:01:48 UTC
[maven-wrapper-plugin] branch MWRAPPER-14 updated: [MWRAPPER-14]
update documentation
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MWRAPPER-14
in repository https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git
The following commit(s) were added to refs/heads/MWRAPPER-14 by this push:
new 0d84a89 [MWRAPPER-14] update documentation
0d84a89 is described below
commit 0d84a89d1f881d45d9bf3535475d46c408b1ff84
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Nov 7 21:01:46 2021 +0100
[MWRAPPER-14] update documentation
---
.../src/site/apt/index.apt.vm | 2 +-
maven-wrapper-distribution/src/site/site.xml | 3 ---
maven-wrapper-plugin/src/site/markdown/index.md.vm | 5 ++---
maven-wrapper-plugin/src/site/markdown/usage.md | 4 ++--
maven-wrapper-plugin/src/site/site.xml | 10 ++--------
maven-wrapper/src/site/apt/index.apt | 4 ++--
maven-wrapper/src/site/site.xml | 2 --
pom.xml | 22 +---------------------
{maven-wrapper/src => src}/site/apt/index.apt | 9 +++++++--
.../src => src}/site/resources/download.cgi | 0
{maven-wrapper-plugin/src => src}/site/site.xml | 22 ++++++++++++----------
.../src => src}/site/xdoc/download.xml.vm | 12 ++++++------
12 files changed, 35 insertions(+), 60 deletions(-)
diff --git a/maven-wrapper-distribution/src/site/apt/index.apt.vm b/maven-wrapper-distribution/src/site/apt/index.apt.vm
index a8ecdc9..7592f68 100644
--- a/maven-wrapper-distribution/src/site/apt/index.apt.vm
+++ b/maven-wrapper-distribution/src/site/apt/index.apt.vm
@@ -55,4 +55,4 @@ mvnwDebug.cmd
[]
- Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{/plugins/maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
+ Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{../maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
diff --git a/maven-wrapper-distribution/src/site/site.xml b/maven-wrapper-distribution/src/site/site.xml
index cd7807c..7673a9a 100644
--- a/maven-wrapper-distribution/src/site/site.xml
+++ b/maven-wrapper-distribution/src/site/site.xml
@@ -21,9 +21,6 @@ under the License.
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
-
- <edit>${project.scm.url}</edit>
-
<body>
<menu ref="parent"/>
<menu ref="reports"/>
diff --git a/maven-wrapper-plugin/src/site/markdown/index.md.vm b/maven-wrapper-plugin/src/site/markdown/index.md.vm
index 29bcac0..8746af6 100644
--- a/maven-wrapper-plugin/src/site/markdown/index.md.vm
+++ b/maven-wrapper-plugin/src/site/markdown/index.md.vm
@@ -18,15 +18,14 @@ specific language governing permissions and limitations
under the License.
-->
-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.
+The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](../maven-wrapper-distribution/).
Goals Overview
--------------
* [wrapper:wrapper](./wrapper-mojo.html) is the default goal invoked during the
- `wrapper` phase. It downloads and unpacks the apache-maven-wrapper distribution,
+ `wrapper` phase. It downloads and unpacks the maven-wrapper distribution,
Usage
-----
diff --git a/maven-wrapper-plugin/src/site/markdown/usage.md b/maven-wrapper-plugin/src/site/markdown/usage.md
index 3c147fa..e7b8671 100644
--- a/maven-wrapper-plugin/src/site/markdown/usage.md
+++ b/maven-wrapper-plugin/src/site/markdown/usage.md
@@ -48,7 +48,7 @@ This type comes with a `.mvn/wrapper/MavenWrapperDownloader.java` which will be
Maven Version
-------------
By default the plugin will assume the same version as the Maven runtime (calling `mvn -v`). But you can pick a different version.
-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
+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
Another option is adjust the `distributionUrl` in `.mvn/wrapper/maven-wrapper.properties`
Debugging
@@ -56,4 +56,4 @@ Debugging
The apache-maven-wrapper distributions all contains the `mvnwDebug`-script for both Windows and Unix based operating systems.
This makes it possible to debug through Apache Maven, Maven Plugin or Maven Extension.
-You can exclude these scripts by calling `mvn wrapper -DincludeDebug=false`
\ No newline at end of file
+You can exclude these scripts by calling `mvn wrapper:wrapper -DincludeDebug=false`
\ No newline at end of file
diff --git a/maven-wrapper-plugin/src/site/site.xml b/maven-wrapper-plugin/src/site/site.xml
index 3b846b6..9678ca4 100644
--- a/maven-wrapper-plugin/src/site/site.xml
+++ b/maven-wrapper-plugin/src/site/site.xml
@@ -27,14 +27,8 @@ under the License.
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
- <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
- <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>
+ <menu ref="parent"/>
+ <menu ref="reports"/>
</body>
</project>
diff --git a/maven-wrapper/src/site/apt/index.apt b/maven-wrapper/src/site/apt/index.apt
index c579786..5e449c5 100644
--- a/maven-wrapper/src/site/apt/index.apt
+++ b/maven-wrapper/src/site/apt/index.apt
@@ -25,6 +25,6 @@
Maven Wrapper
- 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.
+ 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.
- 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>>>.
+ 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>>>.
diff --git a/maven-wrapper/src/site/site.xml b/maven-wrapper/src/site/site.xml
index e475330..1c1c7d8 100644
--- a/maven-wrapper/src/site/site.xml
+++ b/maven-wrapper/src/site/site.xml
@@ -22,8 +22,6 @@ under the License.
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
- <edit>${project.scm.url}</edit>
-
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
diff --git a/pom.xml b/pom.xml
index ce73810..4c972be 100644
--- a/pom.xml
+++ b/pom.xml
@@ -40,10 +40,6 @@ under the License.
</description>
<inceptionYear>2020</inceptionYear>
- <prerequisites>
- <maven>${mavenVersion}</maven>
- </prerequisites>
-
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</developerConnection>
@@ -66,6 +62,7 @@ under the License.
</distributionManagement>
<properties>
+ <maven.site.path>wrapper-archives/wrapper-LATEST</maven.site.path>
<mavenVersion>3.1.0</mavenVersion>
<javaVersion>8</javaVersion>
<project.build.outputTimestamp>2021-04-05T14:15:37Z</project.build.outputTimestamp>
@@ -76,21 +73,4 @@ under the License.
<module>maven-wrapper-distribution</module>
<module>maven-wrapper-plugin</module>
</modules>
-
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-project-info-reports-plugin</artifactId>
- <version>3.1.0</version>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
</project>
diff --git a/maven-wrapper/src/site/apt/index.apt b/src/site/apt/index.apt
similarity index 69%
copy from maven-wrapper/src/site/apt/index.apt
copy to src/site/apt/index.apt
index c579786..b150a80 100644
--- a/maven-wrapper/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -25,6 +25,11 @@
Maven Wrapper
- 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.
+ Maven Wrapper is composed of 3 pieces:
+
+ - {{{./maven-wrapper/} maven-wrapper}},
- 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>>>.
+ - {{{./maven-wrapper-distribution/} maven-wrapper distribution}}, that provides <<<mvnw>>>:<<<mvnw.cmd>>> scripts distributions,
+
+ - {{{./maven-wrapper-plugin/} maven-wrapper-plugin}}, a plugin to ease installing Wrapper into a project.
+
\ No newline at end of file
diff --git a/maven-wrapper-plugin/src/site/resources/download.cgi b/src/site/resources/download.cgi
similarity index 100%
rename from maven-wrapper-plugin/src/site/resources/download.cgi
rename to src/site/resources/download.cgi
diff --git a/maven-wrapper-plugin/src/site/site.xml b/src/site/site.xml
similarity index 63%
copy from maven-wrapper-plugin/src/site/site.xml
copy to src/site/site.xml
index 3b846b6..b6816dd 100644
--- a/maven-wrapper-plugin/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,22 +19,24 @@ specific language governing permissions and limitations
under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+<project xmlns="https://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="https://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
<body>
+ <breadcrumbs>
+ <item name="Wrapper" href="https://maven.apache.org/wrapper/index.html" />
+ </breadcrumbs>
+
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="Goals" href="plugin-info.html"/>
- <item name="Usage" href="usage.html"/>
+ <!--item name="JavaDocs" href="apidocs/index.html"/-->
+ <!--item name="Source Xref" href="xref/index.html"/-->
+ <!--item name="FAQ" href="faq.html"/-->
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
- <item name="License" href="http://www.apache.org/licenses/"/>
+ <item name="License" href="https://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>
+ <menu ref="modules" />
</body>
</project>
diff --git a/maven-wrapper-plugin/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
similarity index 82%
rename from maven-wrapper-plugin/src/site/xdoc/download.xml.vm
rename to src/site/xdoc/download.xml.vm
index 5130c5c..259ba70 100644
--- a/maven-wrapper-plugin/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -34,12 +34,12 @@ under the License.
<p>In order to guard against corrupted downloads/installations, it is highly recommended to
<a href="http://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a>
- of the release bundles against the public <a href="http://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
+ of the release bundles against the public <a href="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
developers.</p>
<p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
- <p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="/guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p>
+ <p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="./guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p>
<a name="mirror"/>
<subsection name="Mirror">
@@ -107,9 +107,9 @@ under the License.
<tbody>
<tr>
<td>${project.name} ${project.version} (Source zip)</td>
- <td><a href="[preferred]maven/plugins/${project.artifactId}-${project.version}-source-release.zip">maven/plugins/${project.artifactId}-${project.version}-source-release.zip</a></td>
- <td><a href="https://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
- <td><a href="https://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc">maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
+ <td><a href="[preferred]maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip">maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip</a></td>
+ <td><a href="https://www.apache.org/dist/maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
+ <td><a href="https://www.apache.org/dist/maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip.asc">maven/plugin-tools/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
</tr>
</tbody>
</table>
@@ -117,7 +117,7 @@ under the License.
<subsection name="Previous Versions">
- <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
+ <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/plugin-tools/">archive site</a>.</p>
</subsection>
</section>