From 20c5286c7c8de832a6a03c46b0f8f390423bf5ba Mon Sep 17 00:00:00 2001
From: Benson Margulies <bimargulies@apache.org>
Date: Fri, 2 Sep 2011 15:47:35 +0000
Subject: [PATCH] [MPLUGIN-179] Clarify the goalPrefix (is there a default
 value for example) param

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1164587 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/maven/plugin/plugin/PluginReport.java    | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
index 1044800..bc6d394 100644
--- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
+++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
@@ -124,7 +124,18 @@ public class PluginReport
     private Requirements requirements;
 
     /**
-     * The goal prefix that will appear before the ":".
+     * The goal prefix that will appear before the ":". 
+     * By default, this plugin applies a heuristic to derive a heuristic from 
+     * the plugin's artifactId. 
+     * 
+     * It removes any occurrences of the regular expression <strong>-?maven-?</strong>,
+     * and then removes any occurrences of <strong>-?plugin-?</strong>.
+     * <p>
+     * For example, horsefeature-maven-plugin becomes horsefeather.
+     * </p>
+     * <p>
+     * (There is a special for maven-plugin-plugin; it is mapped to 'plugin'.
+     * </p>
      *
      * @parameter expression="${goalPrefix}"
      * @since 2.4