"medium" mode should be the default for help:describe
-----------------------------------------------------

                 Key: MPH-32
                 URL: http://jira.codehaus.org/browse/MPH-32
             Project: Maven 2.x Help Plugin
          Issue Type: Improvement
            Reporter: Dan Fabulich


Right now if you "mvn help:describe -Dplugin=compiler" you'll see this:

{noformat}
[INFO] Plugin: 'org.apache.maven.plugins:maven-compiler-plugin:2.0.2'
-----------------------------------------------
Group Id:  org.apache.maven.plugins
Artifact Id: maven-compiler-plugin
Version:     2.0.2
Goal Prefix: compiler
Description:

Maven Plugins
{noformat}

This doesn't include the list of goals in this plugin.  Similarly, if you "mvn 
help:describe -Dplugin=compiler -Dmojo=compile" you'll see this:

{noformat}
===============================================
Goal: 'compile'
Description:
Compiles application sources
===============================================
{noformat}

This doesn't describe any of the plugin parameters.

The problem here is that the "default" amount of information shown by 
help:describe is just way too minimal, requiring the user to be clever enough 
to add -Dmedium or -Dfull to get the information that they'd see for free if 
they looked at the website.

-Dmedium should be the default mode; if people just want to see the minimal 
amount of information, we could add a new mode called -Dminimal or -Dshort that 
would include less information.  Overall, IMO the goal should be that running 
mvn help:describe should, by default, give approximately the same information 
you'd get by browsing to a plugin's site.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to