suggestion for mvn --help message

2006-06-12 Thread Marc Weber
Hi .

I'm still new to maven.
A problem which I and other encounter is : Where to get information
about what I can do with maven, wehre to look it up?

My first attempt (most unix users will do)
mvn --help.

Which prints nice information but not:
Which plugins are availible and where to get the description of them..
You  can (as I did) ask the mailinglist to get the answer:

mvn help:describe -Dplugin=.. -DFull=true
or
mvn help:describe -DArtifactId=.. -DGroupId=.. -DFull=true

What about adding this command as hint to mvn --help?


=== this is now ===

usage: mvn [options] [goal(s)] [phase(s)]

Options:
 -C,--strict-checksums Fail the build if checksums don't match
 -c,--lax-checksumsWarn if checksums don't match
 -P,--activate-profilesComma-delimited list of profiles to
   activate
 -ff,--fail-fast   Stop at first failure in reactorized builds
 -fae,--fail-at-endOnly fail the build afterwards; allow all
   non-impacted builds to continue
 -B,--batch-mode   Run in non-interactive (batch) mode
 -fn,--fail-never  NEVER fail the build, regardless of project
   result
 -up,--update-plugins  Synonym for cpu
 -N,--non-recursiveDo not recurse into sub-projects
 -npr,--no-plugin-registry Don't use ~/.m2/plugin-registry.xml for
   plugin versions
 -U,--update-snapshots Update all snapshots regardless of
   repository policies
 -cpu,--check-plugin-updates   Force upToDate check for any relevant
   registered plugins
 -npu,--no-plugin-updates  Suppress upToDate check for any relevant
   registered plugins
 -D,--define   Define a system property
 -X,--debugProduce execution debug output
 -e,--errors   Produce execution error messages
 -f,--file Force the use of an alternate POM file.
 -h,--help Display help information
 -o,--offline  Work offline
 -r,--reactor  Execute goals for project found in the
   reactor
 -s,--settings Alternate path for the user settings file
 -v,--version  Display version information

== why not add ===
  --show-plugininfo/ [or --show-new-user-info ?]
  which prints something like 

  To get the description of a plugin try
mvn help:describe -DFull=true plugin   where plugin is either
-Dplugin or -DartifactId=maven-pluginname-plugin 
-DgroupId=org.apache.maven.plugins

   To get a list of plugins goto http://maven.apache.org/plugins/index.html
   or have a look at the maven 2 repo directory 
http://www.ibiblio.org/maven2/org/apache/maven/plugins/ 

   ... [Wht

This would help any newbe to get started as having plugnis and a build
cycle description is the main feature of maven, isn't it?

Another thing: If you are looking for pom.xml and some description, you
are out of luck. You have to click on Guides-References- Project Descriptor.

What do you think?

Greetings
  Marc Weber

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: suggestion for mvn --help message

2006-06-12 Thread Mark Hobson

I agree some further plugin information would be useful - I raised a
similar issue the other day:

http://jira.codehaus.org/browse/MNG-2310

Mark

On 12/06/06, Marc Weber [EMAIL PROTECTED] wrote:

Hi .

I'm still new to maven.
A problem which I and other encounter is : Where to get information
about what I can do with maven, wehre to look it up?

My first attempt (most unix users will do)
mvn --help.

Which prints nice information but not:
Which plugins are availible and where to get the description of them..
You  can (as I did) ask the mailinglist to get the answer:

mvn help:describe -Dplugin=.. -DFull=true
or
mvn help:describe -DArtifactId=.. -DGroupId=.. -DFull=true

What about adding this command as hint to mvn --help?


=== this is now ===

usage: mvn [options] [goal(s)] [phase(s)]

Options:
 -C,--strict-checksums Fail the build if checksums don't match
 -c,--lax-checksumsWarn if checksums don't match
 -P,--activate-profilesComma-delimited list of profiles to
   activate
 -ff,--fail-fast   Stop at first failure in reactorized builds
 -fae,--fail-at-endOnly fail the build afterwards; allow all
   non-impacted builds to continue
 -B,--batch-mode   Run in non-interactive (batch) mode
 -fn,--fail-never  NEVER fail the build, regardless of project
   result
 -up,--update-plugins  Synonym for cpu
 -N,--non-recursiveDo not recurse into sub-projects
 -npr,--no-plugin-registry Don't use ~/.m2/plugin-registry.xml for
   plugin versions
 -U,--update-snapshots Update all snapshots regardless of
   repository policies
 -cpu,--check-plugin-updates   Force upToDate check for any relevant
   registered plugins
 -npu,--no-plugin-updates  Suppress upToDate check for any relevant
   registered plugins
 -D,--define   Define a system property
 -X,--debugProduce execution debug output
 -e,--errors   Produce execution error messages
 -f,--file Force the use of an alternate POM file.
 -h,--help Display help information
 -o,--offline  Work offline
 -r,--reactor  Execute goals for project found in the
   reactor
 -s,--settings Alternate path for the user settings file
 -v,--version  Display version information

== why not add ===
  --show-plugininfo/ [or --show-new-user-info ?]
  which prints something like

  To get the description of a plugin try
mvn help:describe -DFull=true plugin   where plugin is either
-Dplugin or -DartifactId=maven-pluginname-plugin 
-DgroupId=org.apache.maven.plugins

   To get a list of plugins goto http://maven.apache.org/plugins/index.html
   or have a look at the maven 2 repo directory 
http://www.ibiblio.org/maven2/org/apache/maven/plugins/

   ... [Wht

This would help any newbe to get started as having plugnis and a build
cycle description is the main feature of maven, isn't it?

Another thing: If you are looking for pom.xml and some description, you
are out of luck. You have to click on Guides-References- Project Descriptor.

What do you think?

Greetings
  Marc Weber

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]




-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]