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 2026/08/03 16:14:39 UTC
(maven-site) branch tools created (now 89b10449)
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a change to branch tools
in repository https://gitbox.apache.org/repos/asf/maven-site.git
at 89b10449 review and update tools doc
This branch includes the following new commits:
new 89b10449 review and update tools doc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-site) 01/01: review and update tools doc
Posted by hb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch tools
in repository https://gitbox.apache.org/repos/asf/maven-site.git
commit 89b10449b17bd411bae91b9188b2d3144f57d220
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Aug 3 17:14:27 2026 +0100
review and update tools doc
---
content/markdown/tools/index.md | 15 ++++++---------
content/markdown/tools/mvnup.md | 39 +++++++++++++++++----------------------
content/site.xml | 1 +
3 files changed, 24 insertions(+), 31 deletions(-)
diff --git a/content/markdown/tools/index.md b/content/markdown/tools/index.md
index 569252c1..305e93ed 100644
--- a/content/markdown/tools/index.md
+++ b/content/markdown/tools/index.md
@@ -17,21 +17,18 @@ specific language governing permissions and limitations
under the License.
-->
-<head>
- <title>Maven Tools</title>
-</head>
-
# Maven Tools
The pages in this section will give information about additional Maven tools, which can help to improve your build.
## Supported By The Maven Project
-| Name | Description | Link |
-|:-------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------|
-| [Maven Daemon](./mvnd.html) | This project speeds up Maven builds using daemon process management and caching. | [Github][1] |
-| [Maven Upgrade Tool](./mvnup.html) | The Maven Upgrade Tool allows you to automatically upgrade your Maven project to newer Maven versions, starting with Maven 4. It's a built-in tool, shipped with Maven. | - |
-| [Maven Wrapper](./mavenwrapper.html) | The Maven Wrapper ensures that a project is built with a desired Maven version and/or JDK by automatically downloading them. | [Project's site][2] |
+| Name | Description | Link |
+|:-------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------|
+| [Maven Daemon](./mvnd.html) | `mvnd` speeds up Maven builds using daemon process management and caching. | [Github][1] |
+| [Maven Shell](./mvnsh.html) | `mvnsh` is a shell that permits reuse of a single JVM during development. It's a built-in tool, shipped with Maven. | - |
+| [Maven Upgrade Tool](./mvnup.html) | `mvnup` allows you to automatically upgrade your Maven project to newer Maven versions, starting with Maven 4. It's a built-in tool, shipped with Maven. | - |
+| [Maven Wrapper](./mavenwrapper.html) | `mvnw` ensures that a project is built with a desired Maven version and/or JDK by automatically downloading them. | [Project's site][2] |
[1]: https://github.com/apache/maven-mvnd
[2]: https://maven.apache.org/wrapper/
diff --git a/content/markdown/tools/mvnup.md b/content/markdown/tools/mvnup.md
index 398ab7bf..3c2a8b72 100644
--- a/content/markdown/tools/mvnup.md
+++ b/content/markdown/tools/mvnup.md
@@ -19,7 +19,7 @@ specific language governing permissions and limitations
under the License.
-->
-The Maven Upgrade Tool (`mvnup`) helps you to upgrade your project's (`pom.xml`) files to Maven 4 specific features.
+The Maven Upgrade Tool (`mvnup`) helps you to upgrade your project's `pom.xml` files to Maven 4 specific features.
*Notes*:
@@ -56,7 +56,7 @@ The Maven Upgrade Tool (`mvnup`) helps you to upgrade your project's (`pom.xml`)
- Fix incorrect `parent.relativePath` pointing to non-existent POMs
- Create `.mvn` directory for root directory detection to avoid warnings when build is executed with Maven 4
-### Intelligent Model Inference
+### Intelligent Model Inference (Maven 4 only)
- Parent element trimming when parent is in same project
- Managed dependency removal for project artifacts
@@ -75,24 +75,21 @@ The Maven Upgrade Tool (`mvnup`) helps you to upgrade your project's (`pom.xml`)
## Usage
The tool itself is called using the `mvnup` command.
-The Maven Upgrade Tool needs three things to execute successfully:
+The Maven Upgrade Tool runs based on 3 aspects:
-1. The desired execution mode,
-2. the target model version, and
-3. the part(s) of the `pom.xml` that should be upgraded.
+1. the desired execution mode as a goal:
+ - `check` is a dry check to see if an upgrade of the `pom.xml` files is possible and which parts would be changed,
+ - `apply` updates the files and applies applicable upgrades provided by the tool.
+2. the target model version (`--model-version`/`-m`, defaults to `4.0.0`), and
+3. the part(s) of the `pom.xml` that should be upgraded (defaults to all available updates).
-The tool provides two execution modes (goals):
-The first one is a dry check to see if an upgrade of the `pom.xml` files is possible and which parts would be changed.
-The second mode updates the files and applies applicable upgrades provided by the tool.
-To execute a dry run pass `--check` to the tool, for an upgrade use `--apply`.
+With the `--model-version` (or `-m`) argument you control if your project should be kept to model version `4.0.0` or upgraded to the new `4.1.0` version.
+Model version 4.0.0 is fully compatible with Maven 3, while projects with a model version `4.1.0` can only be built using Maven 4.
+If not specified the tool will target model version `4.0.0`.
-With the `--model-version` argument you control if your project should be upgraded to model version 4.0.0 or the new 4.1.0 version.
-Model version 4.0.0 is fully compatible with Maven 3, while projects with a model version 4.1.0 can only be built, using Maven 4.
-If not specified the tool will target model version 4.0.0.
-
-The tool allows you to update all or only certain parts of your Build POM, by passing upgrade options to the execution.
-In most cases you want it to check / update all parts.
-This is achieved by either passing `-all` or no upgrade option, making it the default behavior.
+The tool allows you to update all or only certain parts of your `pom.xml` Build POM, by passing upgrade options to the execution.
+In most cases you want it to check / update all parts:
+This is achieved by either passing `-all` (or `-a`) or no upgrade option, making it the default behavior.
To specify one or multiple upgrades the following upgrade options can be used:
- `--model`: Only upgrades those parts of the `pom.xml` that are incompatible with Maven 4, for example XML elements or expressions.
@@ -107,7 +104,7 @@ Please see the following example section of this article for an output example.
### Specify project directory
Similar to a standard Maven build, the Maven Upgrade Tool searches for a project in the same folder in which the tool got executed.
-To specify another directory, the `--directory` argument comes to your help.
+To specify another directory, the `--directory` (or `-d`) argument comes to your help.
Example:
@@ -117,7 +114,7 @@ mvnup check --model-version 4.1.0 --directory /path/to/project
### Help
-A short help about the command line arguments is available using the `--help` argument.
+A short help about the command line arguments is available using the `--help` argument or the `help` goal.
## Examples
@@ -142,7 +139,7 @@ mvnup apply --model-version 4.1.0 --all
Upgrade all plugins and models to version 4.0.0:
```
-mvnup apply --plugins --model
+mvnup apply --plugins
```
Check for duplicate plugin and dependency declaration in combination with specifying the directory of the project:
@@ -227,6 +224,4 @@ D:\Github\mpmd386\PMD_314\SingleModuleRoot>mvnup apply --model-version 4.1.0 --a
[INFO] ✓ No upgrades needed - all POMs are up to date
[INFO]
[INFO] Saving modified POMs...
-
```
-
diff --git a/content/site.xml b/content/site.xml
index eeb6126f..fd91d20b 100644
--- a/content/site.xml
+++ b/content/site.xml
@@ -55,6 +55,7 @@ under the License.
<item name="Maven Tools" href="/tools/index.html">
<item name="Maven Daemon" href="/tools/mvnd.html"/>
+ <item name="Maven Shell" href="/tools/mvnsh.html"/>
<item name="Maven Upgrade Tool" href="/tools/mvnup.html"/>
<item name="Maven Wrapper" href="/tools/mavenwrapper.html"/>
</item>