Author: vsiveton
Date: Sat Aug 30 07:30:36 2008
New Revision: 690514
URL: http://svn.apache.org/viewvc?rev=690514&view=rev
Log:
o update doc due to recent changes
Modified:
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
Modified:
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt?rev=690514&r1=690513&r2=690514&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
Sat Aug 30 07:30:36 2008
@@ -5,7 +5,7 @@
Maria Odea Ching
Vincent Siveton
------
- 2008-08-28
+ 2008-08-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -137,26 +137,13 @@
+-----+
# mvn help:describe -Dcmd=compiler:compile
...
-[INFO] [help:describe]
-[INFO] 'compiler:compile' is a 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 plugin has 2 goals:
-
-Goal: 'compile'
- Full Goal Name: 'compiler:compile'
+[INFO] 'compiler:compile' is a plugin goal (aka mojo).
+Mojo: 'compiler:compile'
+compiler:compile
Description: Compiles application sources
+ Deprecated. No reason given
-Goal: 'testCompile'
- Full Goal Name: 'compiler:testCompile'
- Description: Compiles application test sources
-
-For more information, run 'mvn help:describe [...] -Dfull'
+For more information, run 'mvn help:describe [...] -Ddetail'
...
+-----+
@@ -182,7 +169,7 @@
been applied, as well as a describe a particular plugin goal to give usage
information.
-For more information, run 'mvn help:describe [...] -Dfull'
+For more information, run 'mvn help:describe [...] -Ddetail'
...
+-----+
@@ -192,7 +179,6 @@
+-----+
# mvn help:describe -Dplugin=help
...
-[INFO] [help:describe]
[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT
Group Id: org.apache.maven.plugins
Artifact Id: maven-help-plugin
@@ -206,56 +192,57 @@
This plugin has 9 goals:
-Goal: 'effective-settings'
- Full Goal Name: 'help:effective-settings'
+help:active-profiles
+ Description: Displays a list of the profiles which are currently active for
+ this build.
+ Deprecated. No reason given
+
+help:all-profiles
+ Description: Displays a list of available profiles under the current
+ project.
+ Note: it will list all profiles for a project. If a profile comes up with a
+ status inactive then there might be a need to set profile activation
+ switches/property.
+ Deprecated. No reason given
+
+help:describe
+ Description: Displays a list of the attributes for a Maven Plugin and/or
+ Mojo (Maven plain Old Java Object).
+ Deprecated. No reason given
+
+help:effective-pom
+ Description: Displays the effective POM as an XML for this build, with the
+ active profiles factored in.
+ Deprecated. No reason given
+
+help:effective-settings
Description: Displays the calculated settings as XML for this project,
given any profile enhancement and the inheritance of the global settings
into the user-level settings.
+ Deprecated. No reason given
+
+help:evaluate
+ Description: Evaluates Maven expressions given by the user in an
+ interactive mode.
+ Deprecated. No reason given
-Goal: 'expressions'
- Full Goal Name: 'help:expressions'
+help:expressions
Description: Displays the supported Plugin expressions used by Maven.
+ Deprecated. No reason given
-Goal: 'help'
- Full Goal Name: 'help:help'
+help:help
Description: Display help information on maven-help-plugin.
Call
mvn help:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
+ Deprecated. No reason given
-Goal: 'system'
- Full Goal Name: 'help:system'
+help:system
Description: Displays a list of the platform details like system properties
and environment variables.
+ Deprecated. No reason given
-Goal: 'active-profiles'
- Full Goal Name: 'help:active-profiles'
- Description: Displays a list of the profiles which are currently active for
- this build.
-
-Goal: 'describe'
- Full Goal Name: 'help:describe'
- Description: Displays a list of the attributes for a Maven Plugin and/or
- Mojo (Maven plain Old Java Object).
-
-Goal: 'effective-pom'
- Full Goal Name: 'help:effective-pom'
- Description: Displays the effective POM as an XML for this build, with the
- active profiles factored in.
-
-Goal: 'evaluate'
- Full Goal Name: 'help:evaluate'
- Description: Evaluates Maven expressions from the user.
-
-Goal: 'all-profiles'
- Full Goal Name: 'help:all-profiles'
- Description: Displays a list of available profiles under the current
- project.
- Note: it will list all profiles for a project. If a profile comes up with a
- status inactive then there might be a need to set profile activation
- switches/property.
-
-For more information, run 'mvn help:describe [...] -Dfull'
+For more information, run 'mvn help:describe [...] -Ddetail'
...
+-----+
@@ -275,5 +262,5 @@
redirect the output to a file. Here is an example of that:
+-----+
-# mvn help:describe -Dplugin=help -Dfull=true -Doutput=/path/to/file
+# mvn help:describe -Dplugin=help -Ddetail=true -Doutput=/path/to/file
+-----+
