This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to annotated tag maven-help-plugin-2.0
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git
commit 57240c4580ae4b80c5efad40154f5fc371fa1f41
Author: John Dennis Casey <jdca...@apache.org>
AuthorDate: Thu Oct 13 00:48:37 2005 +0000
Renaming two mojos named *Plugin, and adding APT doco.
git-svn-id:
https://svn.apache.org/repos/asf/maven/components/trunk/maven-plugins/maven-projecthelp-plugin@319280
13f79535-47bb-0310-9956-ffa450edef68
---
...ProfilesPlugin.java => ActiveProfilesMojo.java} | 2 +-
...fectivePomPlugin.java => EffectivePomMojo.java} | 2 +-
src/site/apt/active-profiles-mojo.apt | 27 +++++++
src/site/apt/describe-mojo.apt | 93 ++++++++++++++++++++++
src/site/apt/effective-pom-mojo.apt | 28 +++++++
src/site/apt/effective-settings-mojo.apt | 26 ++++++
src/site/site.xml | 43 ++++++++++
7 files changed, 219 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesPlugin.java
b/src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesMojo.java
similarity index 98%
rename from
src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesPlugin.java
rename to
src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesMojo.java
index 7da2175..1cd3955 100644
---
a/src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesPlugin.java
+++ b/src/main/java/org/apache/maven/plugins/projecthelp/ActiveProfilesMojo.java
@@ -35,7 +35,7 @@ import java.util.List;
* @goal active-profiles
* @aggregator
*/
-public class ActiveProfilesPlugin extends AbstractMojo
+public class ActiveProfilesMojo extends AbstractMojo
{
/**
diff --git
a/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java
b/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomMojo.java
similarity index 99%
rename from
src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java
rename to
src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomMojo.java
index f5ed1e3..019b833 100644
--- a/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomPlugin.java
+++ b/src/main/java/org/apache/maven/plugins/projecthelp/EffectivePomMojo.java
@@ -35,7 +35,7 @@ import java.util.List;
* @goal effective-pom
* @aggregator
*/
-public class EffectivePomPlugin
+public class EffectivePomMojo
extends AbstractMojo
{
diff --git a/src/site/apt/active-profiles-mojo.apt
b/src/site/apt/active-profiles-mojo.apt
new file mode 100644
index 0000000..2f2f9d8
--- /dev/null
+++ b/src/site/apt/active-profiles-mojo.apt
@@ -0,0 +1,27 @@
+ ---
+ Maven Project Help Plugin :: Active Profiles Mojo
+ ---
+ John Casey
+ ---
+ 12-October-2005
+ ---
+
+Active Profiles Mojo
+
+*Summary
+
+ 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.
+
+*Configurable Parameters
+
+*---------------+----------------------------+--------------+-------------------+--------------+
+| <<Parameter>> | <<Description>> | <<Type>> | <<Default
Value>> | <<Required>> |
+*---------------+----------------------------+--------------+-------------------+--------------+
+| output | Write output to this path. | java.io.File | <<(none)>>
| No |
+*---------------+----------------------------+--------------+-------------------+--------------+
diff --git a/src/site/apt/describe-mojo.apt b/src/site/apt/describe-mojo.apt
new file mode 100644
index 0000000..a07319d
--- /dev/null
+++ b/src/site/apt/describe-mojo.apt
@@ -0,0 +1,93 @@
+ ---
+ Maven Project Help Plugin :: Describe Mojo
+ ---
+ John Casey
+ ---
+ 12-October-2005
+ ---
+
+Describe Mojo
+
+*Summary
+
+ 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.
+
+ Optionally, the output parameter can be specified to divert this output to a
+ file.
+
+*Configurable Parameters
+
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| <<Parameter>> | <<Description>>
| <<Type>> | <<Default Value>> | <<Required>> |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| plugin | One-liner substitute for groupId/artifactId/version, or
prefix | String | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| groupId | The plugin groupId to lookup
| String | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| artifactId | The plugin artifactId to lookup
| String | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| version | The plugin version to lookup
| String | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| mojo | The specific mojo to describe, rather than the whole plugin
| String | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| output | A path for description output, instead of the console
| java.io.File | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+| full | If false, provide a brief description. Otherwise, detail all
| boolean | <<(none)>> | No |
+*---------------+----------------------------------------------------------------+--------------+-------------------+--------------+
+
+*Note on <<<-Dplugin=...>>>
+
+ This parameter is meant to provide two things: convenience and prefix-based
access.
+
+ The convenience comes when specifying a plugin by groupId:artifactId, or by
+ groupId:artifactId:version. Where the more traditional specification of
separate
+ fields would mean specifying this:
+
++---+
+ -DgroupId=org.somewhere -DartifactId=some-plugin -Dversion=0.0.0
++---+
+
+ the use of the plugin parameter allows this:
+
++---+
+ -Dplugin=org.somewhere:some-plugin:0.0.0
++---+
+
+ (NOTE: version is always optional here.)
+
+ On the other hand, the plugin parameter also offers the option to specify a
+ plugin by its prefix, like this:
+
++---+
+ -Dplugin=projecthelp
++---+
+
+*Examples
+
+ [[1]] To display a brief summary of the entire projecthelp plugin, using the
+ prefix for plugin lookup:
+
++---+
+ m2 projecthelp:describe -Dplugin=projecthelp
++---+
+
+ [[2]] To display a full summary of only the describe mojo, again using the
+ prefix to lookup the plugin:
+
++---+
+ m2 projecthelp:describe -Dplugin=projecthelp -Dmojo=describe
-Dfull=true
++---+
+
+ [[3]] To display the most information available for the entire projecthelp
+ plugin, and avoid any confusion about which plugin might be resolved
+ for a particular prefix:
+
++---+
+ m2 projecthelp:describe -Dfull=true \
+ -DgroupId=org.apache.maven.plugins \
+ -DartifactId=maven-projecthelp-plugin
++---+
diff --git a/src/site/apt/effective-pom-mojo.apt
b/src/site/apt/effective-pom-mojo.apt
new file mode 100644
index 0000000..70399e2
--- /dev/null
+++ b/src/site/apt/effective-pom-mojo.apt
@@ -0,0 +1,28 @@
+ ---
+ Maven Project Help Plugin :: Effective POM Mojo
+ ---
+ John Casey
+ ---
+ 12-October-2005
+ ---
+
+Effective POM Mojo
+
+*Summary
+
+ 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.
+
+*Configurable Parameters
+
+*---------------+----------------------------+--------------+-------------------+--------------+
+| <<Parameter>> | <<Description>> | <<Type>> | <<Default
Value>> | <<Required>> |
+*---------------+----------------------------+--------------+-------------------+--------------+
+| output | Write output to this path. | java.io.File | <<(none)>>
| No |
+*---------------+----------------------------+--------------+-------------------+--------------+
diff --git a/src/site/apt/effective-settings-mojo.apt
b/src/site/apt/effective-settings-mojo.apt
new file mode 100644
index 0000000..5bee87a
--- /dev/null
+++ b/src/site/apt/effective-settings-mojo.apt
@@ -0,0 +1,26 @@
+ ---
+ Maven Project Help Plugin :: Effective Settings Mojo
+ ---
+ John Casey
+ ---
+ 12-October-2005
+ ---
+
+Effective Settings Mojo
+
+*Summary
+
+ 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.
+
+ Optionally, the output parameter can be specified to divert this output to a
+ file.
+
+*Configurable Parameters
+
+*---------------+----------------------------+--------------+-------------------+--------------+
+| <<Parameter>> | <<Description>> | <<Type>> | <<Default
Value>> | <<Required>> |
+*---------------+----------------------------+--------------+-------------------+--------------+
+| output | Write output to this path. | java.io.File | <<(none)>>
| No |
+*---------------+----------------------------+--------------+-------------------+--------------+
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..4a7f5c8
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+
+<project name="Maven Project Help Plugin">
+ <bannerLeft>
+ <name>Maven Project Help</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ </links>
+
+ <menu name="Goals">
+ <item name="active-profiles" href="/active-profiles-mojo.html"/>
+ <item name="describe" href="/describe-mojo.html"/>
+ <item name="effective-pom" href="/effective-pom-mojo.html"/>
+ <item name="effective-settings" href="/effective-settings-mojo.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <commits@maven.apache.org>.
