Issue Details (XML | Word | Printable)

Key: MPH-32
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Vincent Siveton
Reporter: Dan Fabulich
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Maven 2.x Help Plugin

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

Created: 04/Feb/08 05:31 PM   Updated: 28/Aug/08 05:23 AM   Resolved: 28/Aug/08 05:23 AM
Return to search
Component/s: None
Affects Version/s: None
Fix Version/s: 2.1

Time Tracking:
Not Specified


 Description  « Hide

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

[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

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:

===============================================
Goal: 'compile'
Description:
Compiles application sources
===============================================

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 our objective 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.



Dan Fabulich made changes - 04/Feb/08 05:32 PM
Field Original Value New Value
Description 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.
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 our objective 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.
Vincent Siveton added a comment - 28/Aug/08 05:23 AM

fixed in r689775, snapshot deployed.


Vincent Siveton made changes - 28/Aug/08 05:23 AM
Assignee Vincent Siveton [ siveton ]
Resolution Fixed [ 1 ]
Fix Version/s 2.1 [ 12300 ]
Status Open [ 1 ] Closed [ 6 ]