Maven 2.x Help Plugin

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

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 2.1
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

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.

Activity

Hide
Vincent Siveton added a comment -

fixed in r689775, snapshot deployed.

Show
Vincent Siveton added a comment - fixed in r689775, snapshot deployed.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: