maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dan Fabulich (JIRA)" <j...@codehaus.org>
Subject [jira] Updated: (MPH-32) "medium" mode should be the default for help:describe
Date Mon, 04 Feb 2008 23:33:57 GMT

     [ http://jira.codehaus.org/browse/MPH-32?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Dan Fabulich updated MPH-32:
----------------------------

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

  was:
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.


> "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 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.

-- 
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

        

Mime
View raw message