You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2012/06/26 09:03:12 UTC

svn commit: r1353837 - in /maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main: java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java resources/help-class-source.vm

Author: olamy
Date: Tue Jun 26 07:03:11 2012
New Revision: 1353837

URL: http://svn.apache.org/viewvc?rev=1353837&view=rev
Log:
[MPLUGIN-217] HelpMojo (always) contains description for the maven-plugin-plugin
Submitted by Tony Chemit.

Modified:
    maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
    maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/resources/help-class-source.vm

Modified: maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java?rev=1353837&r1=1353836&r2=1353837&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java Tue Jun 26 07:03:11 2012
@@ -155,7 +155,7 @@ public class PluginHelpGenerator
         try
         {
             writer = new OutputStreamWriter( new FileOutputStream( helpClass ), request.getEncoding() );
-            writer.write( getHelpClassSources( propertiesFilePath ) );
+            writer.write( getHelpClassSources( propertiesFilePath, pluginDescriptor ) );
             writer.flush();
         }
         catch ( IOException e )
@@ -189,7 +189,7 @@ public class PluginHelpGenerator
     // Private methods
     // ----------------------------------------------------------------------
 
-    protected String getHelpClassSources( String propertiesFilePath )
+    protected String getHelpClassSources( String propertiesFilePath, PluginDescriptor pluginDescriptor )
     {
         Properties properties = new Properties();
         VelocityContext context = new VelocityContext( properties );
@@ -202,6 +202,9 @@ public class PluginHelpGenerator
             properties.put( "helpPackageName", "" );
         }
         properties.put( "pluginHelpPath", propertiesFilePath + "/plugin-help.xml" );
+        properties.put( "artifactId", pluginDescriptor.getArtifactId());
+        properties.put( "goalPrefix", pluginDescriptor.getGoalPrefix());
+
         // FIXME encoding !
 
         StringWriter stringWriter = new StringWriter();

Modified: maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/resources/help-class-source.vm
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/resources/help-class-source.vm?rev=1353837&r1=1353836&r2=1353837&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/resources/help-class-source.vm (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/resources/help-class-source.vm Tue Jun 26 07:03:11 2012
@@ -17,8 +17,8 @@ import java.util.Iterator;
 import java.util.List;
 
 /**
- * Display help information on maven-plugin-plugin.<br/>
- * Call <code>mvn plugin:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.
+ * Display help information on ${artifactId}.<br/>
+ * Call <code>mvn ${goalPrefix}:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.
  * @author
  * @version
  * @goal help