Issue Details (XML | Word | Printable)

Key: MPH-26
Type: Improvement Improvement
Status: Closed Closed
Resolution: Won't Fix
Priority: Major Major
Assignee: Unassigned
Reporter: Eirik Maus
Votes: 0
Watchers: 1
Operations

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

New goal help:help to provide help on how to use helper plugins in maven

Created: 26/Oct/07 03:47 AM   Updated: 05/Aug/08 07:30 AM   Resolved: 05/Aug/08 07:30 AM
Return to search
Component/s: None
Affects Version/s: 2.0
Fix Version/s: 2.1

Time Tracking:
Not Specified

Issue Links:
Related
 
Supercedes
 


 Description  « Hide

It is almost impossible to remember the usage of the helper utility plugins in maven. Every single time I have problems with transient dependencies I end up searching google for "maven help plugin" and "maven dependency plugin". That is not good enough.

The help plugin should have a goal called help, describing the usage of the plugin. This would make help (or, rather, a bootstrap on how to use the help system) available under the obvious command "mvn help:help". This goal could also hint about the existence of the dependency plugin, since many of the difficult problems when using maven are related to complex transitive dependencies.

The command "mvn -help" should also describe the use of the maven-help-plugin, but I will create a separate issue in the maven core module for that.



Barend Garvelink added a comment - 05/Mar/08 06:06 AM

I completely agree with Eirik that the help plugin is too difficult to use. I'd like to venture a bit further; I think the goal shouldn't be any less than the ability to run

>mvn help maven-dependency-plugin    #plugin artifactId


>mvn help compiler                   #plugin prefix


>mvn help                            #displays syntax for the above

Where plugins from both org.apache.maven.plugins and org.codehaus.mojo should be accepted without specifying groupId. I suspect that this can be implemented in a fairly clean manner by introducing a help lifecycle; a launcher tweak may be required to infer -Dplugin= for the second parameter. I think that's an acceptable price to pay.

I also agree with Andrea's comment in MPH-15 that the -Dfull=true output is a bit verbose, and I think the normal output is too terse. I think the correct level of default verbosity would be to render a console version of the first three sections (intro, required parameters, optional parameters) of the "xxxxx-mojo.html" pages in any plugin site (e.g.). The -Dfull=true parameter can remain supported in its current form.

Finally, an outputXML parameter as seen in the analysis mojos of the maven-dependency-plugin would be invaluable.


Vincent Siveton added a comment - 05/Aug/08 07:30 AM

Should be done by the maven-plugin-plugin
mvn help:help will display

...
[INFO] [help:help]
[INFO] The 'org.apache.maven.plugins:maven-help-plugin' plugin has 9 goals:

help:active-profiles
  Lists the profiles which are currently active for this build.

help:system
  Lists the platform details like system properties and environment variables.
...

Also MPH-30 could help you.