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 2024/03/27 14:47:39 UTC
(maven) 01/01: [MNG-4840] fix requiredMavenVersion description #1445
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-4840-4-update
in repository https://gitbox.apache.org/repos/asf/maven.git
commit 82b7185ddacc9faf520b18bc95ca3c8a4d4dc6cb
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Mar 25 23:22:28 2024 +0100
[MNG-4840] fix requiredMavenVersion description #1445
---
api/maven-api-plugin/src/main/mdo/plugin.mdo | 4 ++--
.../org/apache/maven/plugin/descriptor/PluginDescriptor.java | 9 ++++++---
.../apache/maven/plugin/descriptor/PluginDescriptorBuilder.java | 3 +++
3 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/api/maven-api-plugin/src/main/mdo/plugin.mdo b/api/maven-api-plugin/src/main/mdo/plugin.mdo
index 74e94165c0..38bc1f917e 100644
--- a/api/maven-api-plugin/src/main/mdo/plugin.mdo
+++ b/api/maven-api-plugin/src/main/mdo/plugin.mdo
@@ -97,10 +97,10 @@ under the License.
</field>
<field>
<name>requiredMavenVersion</name>
- <version>1.0.0+</version>
+ <version>1.1.0+</version>
<description>
A version range which specifies the supported Maven versions. A version range can either use the usual mathematical syntax "[2.0.10,2.1.0),[3.0,)" or use a single version "2.2.1". The latter is a short form for "[2.2.1,)", i.e. denotes the minimum version required. This value takes precedence over the POMs Maven prerequisite.
- @since Maven 3.0.2
+ @since Maven 4.0.0-alpha-3
</description>
<type>String</type>
</field>
diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java
index 1f041cb851..9a2482eb16 100644
--- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java
+++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java
@@ -81,7 +81,6 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl
private String description;
- // MNG-4840
private String requiredMavenVersion;
private String requiredJavaVersion;
@@ -369,17 +368,21 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl
}
/**
- * Set required Maven version.
+ * Set required Maven version, as defined in plugin's pom.xml since 3.0.2,
+ * as defined in plugin.xml since 4.0.0-alpha-3.
*
* @param requiredMavenVersion Maven version required by the plugin
* @since 3.0.2
*/
+ // used by maven-core's org.apache.maven.plugin.internal.DefaultMavenPluginManager#getPluginDescriptor(...)
+ // and PluginDescriptorBuilder since 4.0.0-alpha-3
public void setRequiredMavenVersion(String requiredMavenVersion) {
this.requiredMavenVersion = requiredMavenVersion;
}
/**
- * Get required Maven version.
+ * Get required Maven version, as defined in plugin's pom.xml since 3.0.2,
+ * as defined in plugin.xml since 4.0.0-alpha-3.
*
* @return the Maven version required by the plugin
* @since 3.0.2
diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
index 0787dec8d2..8685cebf96 100644
--- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
+++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
@@ -41,6 +41,9 @@ import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.configuration.PlexusConfigurationException;
/**
+ * Build plugin descriptor object from {@code plugin.xml}.
+ *
+ * @author Jason van Zyl
*/
public class PluginDescriptorBuilder {