maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From micha...@apache.org
Subject [maven-help-plugin] 01/01: [MPH-133] Drop deprecated alias 'full'
Date Sun, 04 Mar 2018 19:45:36 GMT
This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch MPH-133
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git

commit c2d6976b06e8f6d6cdeaa0249c4841426256dc46
Author: Michael Osipov <michaelo@apache.org>
AuthorDate: Sun Mar 4 15:16:49 2018 +0100

    [MPH-133] Drop deprecated alias 'full'
---
 .../apache/maven/plugins/help/DescribeMojo.java    | 28 +++++++++-------------
 src/site/apt/examples/describe-configuration.apt   |  8 +++----
 2 files changed, 15 insertions(+), 21 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index 61ca458..45ec4e2 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -91,37 +91,37 @@ public class DescribeMojo
      * For deprecated values
      */
     private static final String NO_REASON = "No reason given";
-    
+
     private static final Pattern EXPRESSION = Pattern.compile( "^\\$\\{([^}]+)\\}$" );
 
     // ----------------------------------------------------------------------
     // Mojo components
     // ----------------------------------------------------------------------
-    
+
     /**
      * Component used to get a plugin descriptor from a given plugin.
      */
     @Component
     private MavenPluginManagerHelper pluginManager;
-    
+
     /**
      * Component used to get a plugin by its prefix and get mojo descriptors.
      */
     @Component
     private MojoDescriptorCreator mojoDescriptorCreator;
-    
+
     /**
      * Component used to resolve the version for a plugin.
      */
     @Component
     private PluginVersionResolver pluginVersionResolver;
-    
+
     /**
      * The Maven default built-in lifecycles.
      */
     @Component
     private DefaultLifecycles defaultLifecycles;
-    
+
     /**
      * A map from each packaging to its lifecycle mapping.
      */
@@ -190,9 +190,9 @@ public class DescribeMojo
     /**
      * This flag specifies that a detailed (verbose) list of goal (Mojo) information should
be given.
      *
-     * @since 2.1, was <code>full</code> in 2.0.x
+     * @since 2.1
      */
-    @org.apache.maven.plugins.annotations.Parameter( property = "detail", defaultValue =
"false", alias = "full" )
+    @org.apache.maven.plugins.annotations.Parameter( property = "detail", defaultValue =
"false" )
     private boolean detail;
 
     /**
@@ -273,18 +273,12 @@ public class DescribeMojo
      */
     private void validateParameters()
     {
-        // support legacy parameters "mojo" and "full"
+        // support legacy parameter "mojo"
         if ( goal == null && session.getUserProperties().get( "mojo" ) != null )
         {
             goal = session.getUserProperties().getProperty( "mojo" );
         }
 
-        if ( !detail && session.getUserProperties().get( "full" ) != null )
-        {
-            String full = session.getUserProperties().getProperty( "full" );
-            detail = Boolean.parseBoolean( full );
-        }
-
         if ( detail || minimal )
         {
             medium = false;
@@ -1003,7 +997,7 @@ public class DescribeMojo
     /**
      * Determines if this Mojo should be used as a report or not. This resolves the plugin
project along with all of its
      * transitive dependencies to determine if the Java class of this goal implements <code>MavenReport</code>.
-     * 
+     *
      * @param md Mojo descriptor
      * @return Whether or not this goal should be used as a report.
      */
@@ -1040,7 +1034,7 @@ public class DescribeMojo
     /**
      * Transforms the given plugin descriptor into an artifact coordinate. It is formed by
its GAV information, along
      * with the given type.
-     * 
+     *
      * @param pd Plugin descriptor.
      * @param type Extension for the coordinate.
      * @return Coordinate of an artifact having the same GAV as the given plugin descriptor,
with the given type.
diff --git a/src/site/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt
index fa0facd..1f40f83 100644
--- a/src/site/apt/examples/describe-configuration.apt
+++ b/src/site/apt/examples/describe-configuration.apt
@@ -147,9 +147,9 @@ For more information, run 'mvn help:describe [...] -Ddetail'
 ...
 +-----+
 
-* The <<<minimal>>>, <<<medium>>> and <<<full>>>
Parameters
+* The <<<minimal>>>, <<<medium>>> and <<<detail>>>
Parameters
 
- If you want to display less or more detailed information, you can use the <<<minimal>>>,
<<<medium>>> or <<<full>>>
+ If you want to display less or more detailed information, you can use the <<<minimal>>>,
or <<<detail>>>
  parameters.
 
  The <<<minimal>>> parameter adds a minimal list of information:
@@ -242,11 +242,11 @@ For more information, run 'mvn help:describe [...] -Ddetail'
 ...
 +-----+
 
- The <<<full>>> parameter also displays information about the mojos's implementation,
their parameters and component
+ The <<<detail>>> parameter also displays information about the mojos's
implementation, their parameters and component
  requirements, among others.
 
 +-----+
-# mvn help:describe -Dplugin=help -Dfull=true
+# mvn help:describe -Dplugin=help -Ddetail=true
 +-----+
 
   <<Note>>: The <<<medium>>> parameter was added in version
2.0.2 and the <<<minimal>>> parameter was added in version

-- 
To stop receiving notification emails like this one, please contact
michaelo@apache.org.

Mime
View raw message