This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to annotated tag maven-help-plugin-2.0.2
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git
commit 7d6e39b4570f868c82fb7526fca32ed9fd3d3185
Author: Dennis Lundberg <denn...@apache.org>
AuthorDate: Sun Nov 11 23:17:21 2007 +0000
o Add an example of how to use the mojo parameter.
o Move "Redirecting output to a file" to its own section.
o Add formating and fix typos.
git-svn-id:
https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593988
13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/usage.apt | 50 +++++++++++++++++++++++++++++---------------------
1 file changed, 29 insertions(+), 21 deletions(-)
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 91af559..1a52dca 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -28,33 +28,30 @@ Usage
Below are the different goals and configurations of the Help plugin.
+
* The <<<help:active-profiles>>> Mojo
The <<<active-profiles>>> mojo is used to discover which profiles have been
applied to the projects currently being built.
For each project in the build session, it will output a list of profiles
which have been applied to that project, along
- with the source of the profile (POM, settings.xml, or profiles.xml).
-
- Optionally, the <<<output>>> parameter can be specified to divert this
output to a file.
+ with the source of the profile (POM, <<<settings.xml>>> or
<<<profiles.xml>>>).
You can execute this mojo using the following command:
+-----+
-mvn help:active-profiles -Doutput=/path/to/file
+mvn help:active-profiles
+-----+
-* The <<<help:describe>>> Mojo
- The <<<describe>>> mojo is used to discover information about Maven plugins.
Given a plugin prefix or groupId, artifactId,
- and optionally version, the mojo will lookup that plugin and output details
about it. If the user also specifies
- which mojo to describe, the <<<describe>>> mojo will limit output to the
details of that mojo, including parameters.
+* The <<<help:describe>>> Mojo
- Optionally, the <<<output>>> parameter can be specified to divert this
output to a file.
+ The <<<describe>>> mojo is used to discover information about Maven plugins.
Given either a <<<plugin>>> or a <<<groupId>>>, an <<<artifactId>>>
+ and optionally a <<<version>>>, the mojo will lookup that plugin and output
details about it. If the user also specifies
+ which <<<mojo>>> to describe, the <<<describe>>> mojo will limit output to
the details of that mojo, including parameters.
This mojo requires either the <<<groupId>>> and <<<artifactId>>> parameters
or the <<<plugin>>> parameter to be specified:
+-----+
-mvn help:describe -DgroupId=org.somewhere
- -DartifactId=some-plugin -Dversion=0.0.0
+mvn help:describe -DgroupId=org.somewhere -DartifactId=some-plugin
-Dversion=0.0.0
+-----+
or
@@ -63,34 +60,45 @@ mvn help:describe -DgroupId=org.somewhere
mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
+-----+
- <<NOTE:>> <<<version>>> is always optional here.
+ Here is an example with the <<<mojo>>> parameter specified:
+
++-----+
+mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin
-Dmojo=describe
++-----+
+
+ <<Note:>> <<<version>>> is always optional here.
+
* The <<<help:effective-pom>>> Mojo
- The <<<effective-pom>>> mojo is used to make visible the POM that results
from the application of interpolation, inheritance,
+ The <<<effective-pom>>> mojo is used to make visible the POM that results
from the application of interpolation, inheritance
and active profiles. It provides a useful way of removing the guesswork
about just what ends up in the POM that Maven uses
to build your project. It will iterate over all projects in the current
build session, printing the effective POM for each.
- Optionally, the <<<output>>> parameter can be specified to divert this
output to a file.
-
The mojo can be executed using the following command:
+-----+
-mvn help:effective-pom -Doutput=/path/to/file
+mvn help:effective-pom
+-----+
-* The <<<help:effective-settings>>> Mojo
- The <<<effective-settings>>> mojo is used to view the Settings that Maven
actually uses to run the build. This Settings
- instance is a result of merging the global file with the user's file, with
the user's file taking precedence.
+* The <<<help:effective-settings>>> Mojo
- Optionally, the <<<output>>> parameter can be specified to divert this
output to a file.
+ The <<<effective-settings>>> mojo is used to view the settings that Maven
actually uses to run the build. These settings
+ are a result of merging the global file with the user's file, with the
user's file taking precedence.
The mojo can be executed using the following command:
+-----+
-mvn help:effective-settings -Doutput=/path/to/file
+mvn help:effective-settings
+-----+
+* Redirecting output to a file
+ All the mojos listed above can use the optional <<<output>>> parameter to
+ divert the output to a file. Here is an example of that:
+
++-----+
+mvn help:active-profiles -Doutput=/path/to/file
++-----+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <commits@maven.apache.org>.
