You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2017/12/20 09:35:41 UTC
[maven-help-plugin] annotated tag maven-help-plugin-2.0.2 created
(now f4cfc95)
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a change to annotated tag maven-help-plugin-2.0.2
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git.
at f4cfc95 (tag)
tagging 8946246bc11cb6ab50e5c112d2873aa73de4f570 (commit)
by Dennis Lundberg
on Sat Nov 24 15:35:07 2007 +0000
- Log -----------------------------------------------------------------
maven-help-plugin-2.0.2
-----------------------------------------------------------------------
This annotated tag includes the following new commits:
new 7e513a9 o Started maven-projecthelp-plugin to help with build analysis (this helped me to visualize profile stuff) current goals: projecthelp:active-profiles projecthelp:effective-pom
new 1eb671a ignore target
new 0044a79 Added projecthelp:effective-settings mojo
new caf6075 change <model> to <project> in root tag.
new 99b15f9 Resolving: MNG-495
new b3913bd Update all versions to beta-1-SNAPSHOT
new 7993994 Fix svn properties
new b4d9851 PR: MNG-596 add XSD definition to m2 poms and archetypes
new 28c43ab Added beginnings of DescribeMojo, and added setters for all mojo parameters in the plugin.
new 2874312 update dependency and parent versions
new 95d12ba cut deps
new 104fa84 [maven-release-plugin] prepare release maven-projecthelp-plugin-2.0-beta-1
new 55c78c5 [maven-release-plugin] prepare for next development iteration
new a77ceaf ignore release.properties and more
new d22ade1 Working on: MNG-786
new f3e822b Fixing error messages related to invalid plugin configuration, similar to the instantiation exception for ArtifactRepository when there is no deployment repository...
new aadea91 o throwing required exception
new f04b735 Fixing DescribeMojo for changes to PluginManager API, and setting prerequisite maven version for this version of the projecthelp-plugin because of this.
new c635f0d use released versions
new a948cf9 Fixing it0013 and it0020, and adding next installment of describe mojo implementation.
new 835611b Resolving: MNG-449, MNG-152, MNG-1090, MNG-1089, MNG-1122
new 678c910 get plugins building again
new 288f175 Resolving: MNG-698, MNG-1081
new 1d13ef5 Adding documentation, to resolve MNG-1082.
new 57240c4 Renaming two mojos named *Plugin, and adding APT doco.
new 36097bf PR: MNG-122 exception clean up phase 1
new 0edacc4 PR: MNG-122 exception clean up phase 2
new 724a2d6 PR: MNG-122 cleanup artifact/plugin not found exception
new 834b377 PR: MNG-122 final exception cleanup - reduce the noise in the lifecycle executor, get rid of response object in favour of exception handling from DefaultMaven.
new 9d402d4 update versions in plugins
new 92b3ace Moving maven-projecthelp-plugin to maven-help-plugin.
new 18e79eb PR: MNG-1285 Submitted By: John Tolentino Reviewed By: John Casey
new 8356e9e move plugins
new efbf541 [maven-release-plugin] prepare release maven-help-plugin-2.0
new 581443a [maven-release-plugin] prepare for next development iteration
new 9ede842 update description
new 984305b Fix typo
new ec8adb1 adjust parent POMs
new 2ddeeb7 correct metadata - effective-settings doesn't require a project. Clean imports.
new dbf0a30 [MPH-10] avoid NPE if plugin is not found
new 22d2fd3 [maven-release-plugin] prepare release maven-help-plugin-2.0
new 5cde901 [maven-release-plugin] prepare for next development iteration
new 880c588 set EOL style
new cff9f8c remove release.properties from ignores
new 55fb64b PR: MPH-17
new b524e05 Commented out FAQ page.
new 520ab0e MNG-2460: Incorrect POM inheritance for plugins
new 3bd4c7e update all parents
new cae3fb0 use inheritence and make all the site appearances consistent
new 1972f29 put back the Overview menu - when you inherit menu items they are meant to be resolved against the parent, by design - so these always belonged in the child POM.
new 9ad8332 MPH-14 Add a mojo to print the dependency tree Submitted by Mark Hobson
new 308d19f update maven-dependency-tree dependency and parent version
new a2368f5 Update parent version to 6, since that has been released and 6-SNAPSHOT hasn't been deployed
new d8fce5b o updating to latest released parent
new e22d0e4 - move plugin-plugin out of 'reporting' for plugins. It's a required part of the site, and does not cause any issues with the reactor or site generation - update to snapshots
new 8fa1288 PR: MPH-21
new cfb5f16 o Set EOL style to native.
new 79ae4d4 o Fix typos. o Add some formating.
new 4d11fc0 Update parent version to 8, as 8-SNAPSHOT is never deployed and 8 is released
new b46eb5c MPH-24: moved tree over to dependency plugin
new 72c531d Added ignores
new c0da4dd o Fix typos.
new 4af25c4 [MPH-25] Adding medium-verbosity flag (just called 'medium'.
new bebf980 o Add @since tag.
new 9f78bc0 o Apply the new license headers.
new 7510c3a o Add xml declaration. o Add used but undeclared dependencies. o Specify version for maven-changelog-plugin.
new 25342a4 o Sort dependencies.
new 5fde6fd o Remove unused but declared dependency.
new 7d6e39b 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.
new 2dfa8e7 o Add info about the 'medium' parameter and an example. o Add formating and fix typos.
new 09e2a48 o Fix errors reported by Checkstyle.
new e2d3d37 [MPH-16] help:active-profiles doesn't include profiles derived from the parent pom. Submitted by: David Boden Reviewed by: Dennis Lundberg
new 07ab326 o Add a proper FAQ.
new 4257fc9 Ignore IDEA files.
new 8946246 [maven-release-plugin] copy for tag maven-help-plugin-2.0.2
The 75 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
--
To stop receiving notification emails like this one, please contact
['"commits@maven.apache.org" <co...@maven.apache.org>'].
[maven-help-plugin] 01/35: [maven-release-plugin] prepare release
maven-help-plugin-2.0
Posted by hb...@apache.org.
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 22d2fd3042cc6b2c3a1de464d09415b808a8479d
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Sun May 7 03:32:23 2006 +0000
[maven-release-plugin] prepare release maven-help-plugin-2.0
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@400406 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 94 ++++++++++++++++++++++++++++++++---------------------------------
1 file changed, 46 insertions(+), 48 deletions(-)
diff --git a/pom.xml b/pom.xml
index 1e01028..3dbfbb0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,48 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <parent>
- <artifactId>maven-plugins</artifactId>
- <groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>maven-help-plugin</artifactId>
- <packaging>maven-plugin</packaging>
- <name>Maven Help Plugin</name>
- <version>2.0.1-SNAPSHOT</version>
- <description>
- The Maven Help plugin provides goals aimed at helping to make sense out of
- the build environment. It includes the ability to view the effective
- POM and settings files, after inheritance and active profiles
- have been applied, as well as a describe a particular plugin goal to give usage information.
- </description>
- <inceptionYear>2001</inceptionYear>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-api</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-settings</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-core</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-tools-api</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-descriptor</artifactId>
- <version>2.0</version>
- </dependency>
- </dependencies>
-</project>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <artifactId>maven-plugins</artifactId>
+ <groupId>org.apache.maven.plugins</groupId>
+ <version>1</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>maven-help-plugin</artifactId>
+ <packaging>maven-plugin</packaging>
+ <name>Maven Help Plugin</name>
+ <version>2.0.1</version>
+ <description>
+ The Maven Help plugin provides goals aimed at helping to make sense out of
+ the build environment. It includes the ability to view the effective
+ POM and settings files, after inheritance and active profiles
+ have been applied, as well as a describe a particular plugin goal to give usage information.
+ </description>
+ <inceptionYear>2001</inceptionYear>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-api</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-settings</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-core</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-tools-api</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-descriptor</artifactId>
+ <version>2.0</version>
+ </dependency>
+ </dependencies>
+</project>
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 03/35: set EOL style
Posted by hb...@apache.org.
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 880c5886558824138e69a8f364911b17ed5a2ab9
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Sun May 7 03:36:01 2006 +0000
set EOL style
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@400409 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 90 ++++++++++++++++++++++++++++++++---------------------------------
1 file changed, 45 insertions(+), 45 deletions(-)
diff --git a/pom.xml b/pom.xml
index 4d5f7a1..f710ffd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,46 +1,46 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <parent>
- <artifactId>maven-plugins</artifactId>
- <groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>maven-help-plugin</artifactId>
- <packaging>maven-plugin</packaging>
- <name>Maven Help Plugin</name>
- <version>2.0.2-SNAPSHOT</version>
- <description>
- The Maven Help plugin provides goals aimed at helping to make sense out of
- the build environment. It includes the ability to view the effective
- POM and settings files, after inheritance and active profiles
- have been applied, as well as a describe a particular plugin goal to give usage information.
- </description>
- <inceptionYear>2001</inceptionYear>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-api</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-settings</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-core</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-tools-api</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-descriptor</artifactId>
- <version>2.0</version>
- </dependency>
- </dependencies>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <artifactId>maven-plugins</artifactId>
+ <groupId>org.apache.maven.plugins</groupId>
+ <version>1</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>maven-help-plugin</artifactId>
+ <packaging>maven-plugin</packaging>
+ <name>Maven Help Plugin</name>
+ <version>2.0.2-SNAPSHOT</version>
+ <description>
+ The Maven Help plugin provides goals aimed at helping to make sense out of
+ the build environment. It includes the ability to view the effective
+ POM and settings files, after inheritance and active profiles
+ have been applied, as well as a describe a particular plugin goal to give usage information.
+ </description>
+ <inceptionYear>2001</inceptionYear>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-api</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-settings</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-core</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-tools-api</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-plugin-descriptor</artifactId>
+ <version>2.0</version>
+ </dependency>
+ </dependencies>
</project>
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 31/35: o Fix errors reported by Checkstyle.
Posted by hb...@apache.org.
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 09e2a484ddcb28b629e9e13217180974a1ed3daa
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 23:32:46 2007 +0000
o Fix errors reported by Checkstyle.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593992 13f79535-47bb-0310-9956-ffa450edef68
---
.../maven/plugins/help/ActiveProfilesMojo.java | 6 ++--
.../apache/maven/plugins/help/DescribeMojo.java | 36 +++++++++-------------
2 files changed, 17 insertions(+), 25 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
index 2daa5b8..1bbb64d 100644
--- a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
@@ -101,7 +101,7 @@ public class ActiveProfilesMojo extends AbstractMojo
{
File dir = output.getParentFile();
- if( !dir.exists() )
+ if ( !dir.exists() )
{
dir.mkdirs();
}
@@ -149,7 +149,7 @@ public class ActiveProfilesMojo extends AbstractMojo
message.append( "Active Profiles for Project \'" + project.getId() + "\': \n\n" );
- if( profiles == null || profiles.isEmpty() )
+ if ( profiles == null || profiles.isEmpty() )
{
message.append( "There are no active profiles." );
}
@@ -163,7 +163,7 @@ public class ActiveProfilesMojo extends AbstractMojo
message.append( "\n - " )
.append( profile.getId() )
- .append(" (source: " )
+ .append( " (source: " )
.append( profile.getSource() ).append( ")" );
}
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index f102477..b2d1e6e 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -323,18 +323,18 @@ public class DescribeMojo
}
catch ( ArtifactResolutionException e )
{
- throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId +
- "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
+ throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId
+ + "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
}
catch ( PluginManagerException e )
{
- throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId +
- "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
+ throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId
+ + "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
}
catch ( PluginVersionResolutionException e )
{
- throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId +
- "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
+ throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId
+ + "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
}
catch ( ArtifactNotFoundException e )
{
@@ -342,13 +342,13 @@ public class DescribeMojo
}
catch ( InvalidVersionSpecificationException e )
{
- throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId +
- "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
+ throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId
+ + "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
}
catch ( InvalidPluginException e )
{
- throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId +
- "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
+ throw new MojoExecutionException( "Error retrieving plugin descriptor for:\n\ngroupId: \'" + groupId
+ + "\'\nartifactId: \'" + artifactId + "\'\nversion: \'" + version + "\'\n\n", e );
}
catch ( PluginNotFoundException e )
{
@@ -364,8 +364,8 @@ public class DescribeMojo
if ( descriptor == null )
{
- throw new MojoFailureException(
- "Plugin could not be found. If you believe it is correct, check your pluginGroups setting, and run with -U to update the remote configuration" );
+ throw new MojoFailureException( "Plugin could not be found. If you believe it is correct,"
+ + " check your pluginGroups setting, and run with -U to update the remote configuration" );
}
return descriptor;
@@ -389,28 +389,20 @@ public class DescribeMojo
switch ( pluginParts.length )
{
case ( 1 ):
- {
pi.prefix = pluginParts[0];
break;
- }
case ( 2 ):
- {
pi.groupId = pluginParts[0];
pi.artifactId = pluginParts[1];
break;
- }
case ( 3 ):
- {
pi.groupId = pluginParts[0];
pi.artifactId = pluginParts[1];
pi.version = pluginParts[2];
break;
- }
default:
- {
throw new MojoFailureException(
"plugin parameter must be a plugin prefix, or conform to: 'groupId:artifactId[:version]." );
- }
}
}
else
@@ -461,7 +453,7 @@ public class DescribeMojo
{
MojoDescriptor md = (MojoDescriptor) it.next();
- if( full )
+ if ( full )
{
buffer.append( line );
buffer.append( "\nGoal: \'" ).append( md.getGoal() ).append( '\'' );
@@ -554,7 +546,7 @@ public class DescribeMojo
{
buffer.append( "\nDescription:\n" );
prettyAppend( formatDescription( md.getDescription() ), buffer );
- if( fullDescription )
+ if ( fullDescription )
{
buffer.append( "\n" );
}
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 35/35: [maven-release-plugin] copy for tag
maven-help-plugin-2.0.2
Posted by hb...@apache.org.
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 8946246bc11cb6ab50e5c112d2873aa73de4f570
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sat Nov 24 15:35:07 2007 +0000
[maven-release-plugin] copy for tag maven-help-plugin-2.0.2
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/tags/maven-help-plugin-2.0.2@597861 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/pom.xml b/pom.xml
index 775cabd..71e36cd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -17,17 +17,17 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
-<project xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd' xmlns='http://maven.apache.org/POM/4.0.0'>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>8</version>
+ <version>10</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
<packaging>maven-plugin</packaging>
<name>Maven Help Plugin</name>
- <version>2.0.2-SNAPSHOT</version>
+ <version>2.0.2</version>
<description>
The Maven Help plugin provides goals aimed at helping to make sense out of
the build environment. It includes the ability to view the effective
@@ -42,6 +42,11 @@ under the License.
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MPH</url>
</issueManagement>
+ <scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/maven/plugins/tags/maven-help-plugin-2.0.2</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/maven/plugins/tags/maven-help-plugin-2.0.2</developerConnection>
+ <url>http://svn.apache.org/viewvc/maven/plugins/tags/maven-help-plugin-2.0.2</url>
+ </scm>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 30/35: o Add info about the 'medium' parameter
and an example. o Add formating and fix typos.
Posted by hb...@apache.org.
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 2dfa8e7d3db9d6301949840b8d001c31df8fef36
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 23:19:11 2007 +0000
o Add info about the 'medium' parameter and an example.
o Add formating and fix typos.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593989 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/examples/describe-configuration.apt | 29 ++++++++++++++++--------
1 file changed, 19 insertions(+), 10 deletions(-)
diff --git a/src/site/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt
index 928e58d..de77a20 100644
--- a/src/site/apt/examples/describe-configuration.apt
+++ b/src/site/apt/examples/describe-configuration.apt
@@ -26,13 +26,13 @@
Configuring Describe Mojo
- Below are other configuration examples for the Describe mojo.
+ Below are other configuration examples for the <<<describe>>> mojo.
* The <<<plugin>>> Parameter
The <<<plugin>>> 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
+ 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:
+---+
@@ -54,7 +54,7 @@ mvn help:describe -Dplugin=help
* The <<<mojo>>> Parameter
- You can use the <<<mojo>>> parameter of the Describe Mojo to show or display relative information about the particular mojo
+ You can use the <<<mojo>>> parameter of the <<<describe>>> mojo to show or display relative information about a particular mojo
of the plugin you specified.
For example, when you execute the following command:
@@ -64,16 +64,25 @@ mvn help:describe -Dmojo=describe -DgroupId=org.apache.maven.plugins
-DartifactId=maven-help-plugin
+-----+
- This would display brief information relative to the Describe Mojo only.
+ This would display brief information about the <<<describe>>> mojo only.
-* The <<<full>>> Parameter
+* The <<<medium>>> and <<<full>>> Parameters
- If you want to show or display detailed information about the mojo, you can use the <<<full>>> parameter, as
- shown below:
+ If you want to display more detailed information, you can use the <<<medium>>>
+ or <<<full>>> parameters.
+
+ The <<<medium>>> parameter adds a list with the mojos of the plugin and their
+ descriptions:
+-----+
-mvn help:describe -Dmojo=describe -DgroupId=org.apache.maven.plugins
- -DartifactId=maven-help-plugin -Dfull=true
+mvn help:describe -Dplugin=help -Dmedium=true
+-----+
- This would display information such as the mojo implementation, its parameters and component requirements, among others.
+ <<Note:>> The <<<medium>>> parameter was added in version 2.0.2 of this plugin.
+
+ The <<<full>>> parameter also displays information about the mojos'
+ implementation, their parameters and component requirements, among others.
+
++-----+
+mvn help:describe -Dplugin=help -Dfull=true
++-----+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 32/35: [MPH-16] help:active-profiles doesn't
include profiles derived from the parent pom. Submitted by: David Boden
Reviewed by: Dennis Lundberg
Posted by hb...@apache.org.
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 e2d3d37f1c9deb1c940d6b73af97ce33f85a074d
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 23:39:58 2007 +0000
[MPH-16] help:active-profiles doesn't include profiles derived from the parent pom.
Submitted by: David Boden
Reviewed by: Dennis Lundberg
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593993 13f79535-47bb-0310-9956-ffa450edef68
---
.../maven/plugins/help/ActiveProfilesMojo.java | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
index 1bbb64d..02443e4 100644
--- a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
@@ -143,7 +143,7 @@ public class ActiveProfilesMojo extends AbstractMojo
*/
private void getActiveProfileStatement( MavenProject project, StringBuffer message )
{
- List profiles = project.getActiveProfiles();
+ List profiles = collectActiveProfiles( project );
message.append( "\n" );
@@ -173,6 +173,25 @@ public class ActiveProfilesMojo extends AbstractMojo
}
/**
+ * Recurses into the project's parent poms to find the active
+ * profiles of the specified project and all its parents.
+ *
+ * @param project The project to start with
+ * @return A list of active profiles
+ */
+ private List collectActiveProfiles( MavenProject project )
+ {
+ List profiles = project.getActiveProfiles();
+
+ if ( project.hasParent() )
+ {
+ profiles.addAll( collectActiveProfiles( project.getParent() ) );
+ }
+
+ return profiles;
+ }
+
+ /**
* Setter method for the list of projects.
*
* @param projects
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 04/35: remove release.properties from ignores
Posted by hb...@apache.org.
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 cff9f8cb1fd57052ce0188b9ed12552717bfb6ee
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Tue May 9 03:09:16 2006 +0000
remove release.properties from ignores
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@405286 13f79535-47bb-0310-9956-ffa450edef68
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 34/35: Ignore IDEA files.
Posted by hb...@apache.org.
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 4257fc993627e09d799c6accd3ecb1ae0ad514ad
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sat Nov 24 15:11:54 2007 +0000
Ignore IDEA files.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@597857 13f79535-47bb-0310-9956-ffa450edef68
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 07/35: MNG-2460: Incorrect POM inheritance for
plugins
Posted by hb...@apache.org.
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 520ab0e1f99be09c96d02c49ea1e843d380960ad
Author: Vincent Siveton <vs...@apache.org>
AuthorDate: Fri Jul 21 20:19:40 2006 +0000
MNG-2460: Incorrect POM inheritance for plugins
Added missing <issueManagement/> and <mailingLists/> tags in pom.xml
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@424442 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/pom.xml b/pom.xml
index a8022c8..b2e612d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -19,6 +19,10 @@
<prerequisites>
<maven>2.0</maven>
</prerequisites>
+ <issueManagement>
+ <system>JIRA</system>
+ <url>http://jira.codehaus.org/browse/MPH</url>
+ </issueManagement>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 27/35: o Sort dependencies.
Posted by hb...@apache.org.
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 25342a4a4cb73c9a61dc8eefb279f50f8d727704
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 22:20:07 2007 +0000
o Sort dependencies.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593977 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/pom.xml b/pom.xml
index ef50a1c..1e539b0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -50,22 +50,22 @@ under the License.
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-api</artifactId>
+ <artifactId>maven-core</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-settings</artifactId>
+ <artifactId>maven-model</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-core</artifactId>
+ <artifactId>maven-plugin-api</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-model</artifactId>
+ <artifactId>maven-plugin-descriptor</artifactId>
<version>2.0</version>
</dependency>
<dependency>
@@ -75,12 +75,12 @@ under the License.
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-descriptor</artifactId>
+ <artifactId>maven-project</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-project</artifactId>
+ <artifactId>maven-settings</artifactId>
<version>2.0</version>
</dependency>
<dependency>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 24/35: o Add @since tag.
Posted by hb...@apache.org.
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 bebf980e672c4224f4cbebbd1aadbf66a544f022
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 22:03:39 2007 +0000
o Add @since tag.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593970 13f79535-47bb-0310-9956-ffa450edef68
---
src/main/java/org/apache/maven/plugins/help/DescribeMojo.java | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index af0ddde..413a2a5 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -181,6 +181,7 @@ public class DescribeMojo
* given. Use true/false.
*
* @parameter expression="${medium}" default-value="false"
+ * @since 2.0.2
*/
private boolean medium;
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 19/35: Update parent version to 8,
as 8-SNAPSHOT is never deployed and 8 is released
Posted by hb...@apache.org.
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 4d11fc08d4bb8fedd71f6fad853fe7d1c48545f5
Author: Kenney Westerhof <ke...@apache.org>
AuthorDate: Wed Mar 14 12:11:00 2007 +0000
Update parent version to 8, as 8-SNAPSHOT is never deployed and 8 is released
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@518106 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index fdc0b2e..e70d609 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>8-SNAPSHOT</version>
+ <version>8</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 08/35: update all parents
Posted by hb...@apache.org.
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 3bd4c7e3846043e515b2a75b3e0191aba94b6d9e
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Sat Oct 21 05:30:08 2006 +0000
update all parents
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@466341 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index b2e612d..2b0a232 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>2-SNAPSHOT</version>
+ <version>4-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 13/35: Update parent version to 6,
since that has been released and 6-SNAPSHOT hasn't been deployed
Posted by hb...@apache.org.
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 a2368f54be581926a3cd674a32683cd094f6db84
Author: Kenney Westerhof <ke...@apache.org>
AuthorDate: Wed Dec 20 13:51:07 2006 +0000
Update parent version to 6, since that has been released and 6-SNAPSHOT hasn't been deployed
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@489088 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index f0d4d9d..d8d0942 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>6-SNAPSHOT</version>
+ <version>6</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 10/35: put back the Overview menu - when you
inherit menu items they are meant to be resolved against the parent,
by design - so these always belonged in the child POM.
Posted by hb...@apache.org.
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 1972f2970b57d5c593b8c4acc6cf64b02e261c00
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Mon Nov 6 22:37:46 2006 +0000
put back the Overview menu - when you inherit menu items they are meant to be resolved against the parent, by design -
so these always belonged in the child POM.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@471905 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/site.xml | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/site/site.xml b/src/site/site.xml
index c7bf522..fa09fe2 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -20,6 +20,12 @@
<project>
<body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
<menu name="Examples">
<item name="Configuring Describe Mojo" href="/examples/describe-configuration.html"/>
</menu>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 25/35: o Apply the new license headers.
Posted by hb...@apache.org.
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 9f78bc0e74ed4b6a251e536dc481801405c91935
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 22:11:17 2007 +0000
o Apply the new license headers.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593973 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 18 +++++++++++++
.../maven/plugins/help/ActiveProfilesMojo.java | 25 +++++++++--------
.../apache/maven/plugins/help/DescribeMojo.java | 25 +++++++++--------
.../maven/plugins/help/EffectivePomMojo.java | 25 +++++++++--------
.../maven/plugins/help/EffectiveSettingsMojo.java | 25 +++++++++--------
src/site/apt/examples/describe-configuration.apt | 17 ++++++++++++
src/site/apt/index.apt | 16 +++++++++++
src/site/apt/usage.apt | 17 ++++++++++++
src/site/fml/faq.fml | 20 ++++++++++++++
src/site/site.xml | 31 +++++++++++-----------
10 files changed, 160 insertions(+), 59 deletions(-)
diff --git a/pom.xml b/pom.xml
index 0f88434..c490fd4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,3 +1,21 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd' xmlns='http://maven.apache.org/POM/4.0.0'>
<parent>
<artifactId>maven-plugins</artifactId>
diff --git a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
index 05712b4..2daa5b8 100644
--- a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
@@ -1,19 +1,22 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2006 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
*
- * 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
*
- * 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.
+ * 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.
*/
import org.apache.maven.model.Profile;
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index 413a2a5..f102477 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -1,19 +1,22 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2006 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
*
- * 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
*
- * 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.
+ * 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.
*/
import java.io.File;
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
index da22d31..8a1d78f 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
@@ -1,19 +1,22 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2006 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
*
- * 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
*
- * 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.
+ * 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.
*/
import org.apache.maven.model.Model;
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
index 21501ff..ef11756 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
@@ -1,19 +1,22 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2006 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
*
- * 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
*
- * 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.
+ * 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.
*/
import org.apache.maven.plugin.AbstractMojo;
diff --git a/src/site/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt
index e225d38..928e58d 100644
--- a/src/site/apt/examples/describe-configuration.apt
+++ b/src/site/apt/examples/describe-configuration.apt
@@ -7,6 +7,23 @@
10 July 2006
------
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
+
Configuring Describe Mojo
Below are other configuration examples for the Describe mojo.
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index b620f97..00c9fdd 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -6,6 +6,22 @@
7 July 2006
------
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
Maven 2 Help Plugin
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 8467f6e..91af559 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -7,6 +7,23 @@
10 July 2006
------
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you 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.
+
Usage
Below are the different goals and configurations of the Help plugin.
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index 17be3dd..e9153bc 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -1,4 +1,24 @@
<?xml version="1.0"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="1">
diff --git a/src/site/site.xml b/src/site/site.xml
index fa09fe2..6b6948c 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -1,21 +1,22 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-/*
- * Copyright 2001-2006 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.
- */
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 23/35: [MPH-25] Adding medium-verbosity flag
(just called 'medium'.
Posted by hb...@apache.org.
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 4af25c47f0a1fc3b35a6c1e1f3290e75aa77e4c0
Author: John Dennis Casey <jd...@apache.org>
AuthorDate: Tue Aug 14 16:45:37 2007 +0000
[MPH-25] Adding medium-verbosity flag (just called 'medium'.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@565831 13f79535-47bb-0310-9956-ffa450edef68
---
.../apache/maven/plugins/help/DescribeMojo.java | 72 ++++++++++++----------
1 file changed, 40 insertions(+), 32 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index c6e5e0d..af0ddde 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -16,6 +16,13 @@ package org.apache.maven.plugins.help;
* limitations under the License.
*/
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.Writer;
+import java.util.Iterator;
+import java.util.List;
+
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
import org.apache.maven.artifact.resolver.ArtifactResolutionException;
@@ -40,13 +47,6 @@ import org.apache.maven.project.ProjectBuildingException;
import org.apache.maven.settings.Settings;
import org.codehaus.plexus.component.repository.ComponentRequirement;
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.Writer;
-import java.util.Iterator;
-import java.util.List;
-
/**
* Describes the attributes of a plugin and/or plugin mojo.
*
@@ -60,7 +60,7 @@ public class DescribeMojo
/**
* The plugin/mojo to describe. This must be specified in one of three ways:
- * <p/>
+ * <br/>
* 1. plugin-prefix
* 2. groupId:artifactId
* 3. groupId:artifactId:version
@@ -71,7 +71,6 @@ public class DescribeMojo
/**
* The plugin groupId to describe.
- * <br/>
* (Used with artifactId specification).
*
* @parameter expression="${groupId}"
@@ -80,7 +79,6 @@ public class DescribeMojo
/**
* The plugin artifactId to describe.
- * <br/>
* (Used with groupId specification).
*
* @parameter expression="${artifactId}"
@@ -98,9 +96,7 @@ public class DescribeMojo
/**
* The goal name of a mojo to describe within the specified plugin.
- * <br/>
* If this parameter is specified, only the corresponding mojo will
- * <br/>
* be described, rather than the whole plugin.
*
* @parameter expression="${mojo}"
@@ -116,9 +112,7 @@ public class DescribeMojo
/**
* The project builder instance used to retrieve the super-project instance
- * <br/>
* in the event there is no current MavenProject instance. Some MavenProject
- * <br/>
* instance has to be present to use in the plugin manager APIs.
*
* @component role="org.apache.maven.project.MavenProjectBuilder"
@@ -127,11 +121,8 @@ public class DescribeMojo
/**
* The current project, if there is one. This is listed as optional, since
- * <br/>
* the help plugin should be able to function on its own. If this
- * <br/>
* parameter is empty at execution time, this mojo will instead use the
- * <br/>
* super-project.
*
* @parameter expression="${project}"
@@ -141,7 +132,6 @@ public class DescribeMojo
/**
* The current user system settings for use in Maven. This is used for
- * <br/>
* plugin manager API calls.
*
* @parameter expression="${settings}"
@@ -152,7 +142,6 @@ public class DescribeMojo
/**
* The current build session instance. This is used for
- * <br/>
* plugin manager API calls.
*
* @parameter expression="${session}"
@@ -163,7 +152,6 @@ public class DescribeMojo
/**
* The local repository ArtifactRepository instance. This is used
- * <br/>
* for plugin manager API calls.
*
* @parameter expression="${localRepository}"
@@ -174,7 +162,6 @@ public class DescribeMojo
/**
* If specified, this parameter will cause the plugin/mojo descriptions
- * <br/>
* to be written to the path specified, instead of writing to the console.
*
* @parameter expression="${output}"
@@ -183,7 +170,6 @@ public class DescribeMojo
/**
* This flag specifies that full (verbose) information should be
- * <br/>
* given. Use true/false.
*
* @parameter expression="${full}" default-value="false"
@@ -191,6 +177,14 @@ public class DescribeMojo
private boolean full;
/**
+ * This flag specifies that a short list of mojo information should be
+ * given. Use true/false.
+ *
+ * @parameter expression="${medium}" default-value="false"
+ */
+ private boolean medium;
+
+ /**
* @see org.apache.maven.plugin.AbstractMojo#execute()
*/
public void execute()
@@ -453,7 +447,7 @@ public class DescribeMojo
prettyAppend( formatDescription( pd.getDescription() ), buffer );
buffer.append( "\n" );
- if ( full )
+ if ( full || medium )
{
buffer.append( "\nMojos:\n" );
@@ -463,14 +457,25 @@ public class DescribeMojo
{
MojoDescriptor md = (MojoDescriptor) it.next();
- buffer.append( line );
- buffer.append( "\nGoal: \'" ).append( md.getGoal() ).append( '\'' );
- buffer.append( line );
+ if( full )
+ {
+ buffer.append( line );
+ buffer.append( "\nGoal: \'" ).append( md.getGoal() ).append( '\'' );
+ buffer.append( line );
- describeMojoGuts( md, buffer, true );
+ describeMojoGuts( md, buffer, true );
- buffer.append( line );
- buffer.append( "\n\n" );
+ buffer.append( line );
+ buffer.append( "\n\n" );
+ }
+ else
+ {
+ buffer.append( "\nGoal: \'" ).append( md.getGoal() ).append( '\'' );
+
+ describeMojoGuts( md, buffer, false );
+
+ buffer.append( "\n" );
+ }
}
}
}
@@ -543,9 +548,12 @@ public class DescribeMojo
*/
private void describeMojoGuts( MojoDescriptor md, StringBuffer buffer, boolean fullDescription )
{
- buffer.append( "\nDescription:\n\n" );
+ buffer.append( "\nDescription:\n" );
prettyAppend( formatDescription( md.getDescription() ), buffer );
- buffer.append( "\n" );
+ if( fullDescription )
+ {
+ buffer.append( "\n" );
+ }
String deprecation = md.getDeprecated();
@@ -696,7 +704,7 @@ public class DescribeMojo
buffer.append( "\nRequired: " ).append( parameter.isRequired() );
buffer.append( "\nDirectly editable: " ).append( parameter.isEditable() );
- buffer.append( "\nDescription:\n\n" );
+ buffer.append( "\nDescription:\n" );
prettyAppend( formatDescription( parameter.getDescription() ), buffer );
String deprecation = parameter.getDeprecated();
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 18/35: o Fix typos. o Add some formating.
Posted by hb...@apache.org.
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 79ae4d4512e859ef827c71b3236ef4e607b1c417
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Thu Mar 1 21:29:32 2007 +0000
o Fix typos.
o Add some formating.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@513511 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/usage.apt | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 1580d48..7436c0d 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -9,7 +9,7 @@
Usage
- Below are the different goals and configuration of the Help plugin.
+ Below are the different goals and configurations of the Help plugin.
* The <<<help:active-profiles>>> Mojo
@@ -17,7 +17,7 @@ Usage
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.
+ Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
You can execute this mojo using the following command:
@@ -30,7 +30,7 @@ mvn help:active-profiles -Doutput=/path/to/file
The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
It will output the resolved tree of dependencies that the Maven build process actually uses.
- Optionally, the output parameter can be specified to divert this output to a file.
+ Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
You can execute this mojo using the following command:
@@ -42,11 +42,11 @@ mvn help:dependencies -Doutput=/path/to/file
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.
+ 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.
+ Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
- This mojo requires either the groupId and artifactId parameters or the plugin parameter to be specified:
+ This mojo requires either the <<<groupId>>> and <<<artifactId>>> parameters or the <<<plugin>>> parameter to be specified:
+-----+
mvn help:describe -DgroupId=org.somewhere
@@ -56,10 +56,10 @@ mvn help:describe -DgroupId=org.somewhere
or
+-----+
-mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
+mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
+-----+
- (NOTE: version is always optional here.)
+ <<NOTE:>> <<<version>>> is always optional here.
* The <<<help:effective-pom>>> Mojo
@@ -67,12 +67,12 @@ mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
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.
+ Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
- The mojo can be executedd using the following command:
+ The mojo can be executed using the following command:
+-----+
-mvn help:effective-profiles -Doutput=/path/to/file
+mvn help:effective-pom -Doutput=/path/to/file
+-----+
* The <<<help:effective-settings>>> Mojo
@@ -80,9 +80,9 @@ mvn help:effective-profiles -Doutput=/path/to/file
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.
+ Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
- The mojo can be executedd using the following command:
+ The mojo can be executed using the following command:
+-----+
mvn help:effective-settings -Doutput=/path/to/file
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 29/35: 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.
Posted by hb...@apache.org.
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 <de...@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" <co...@maven.apache.org>.
[maven-help-plugin] 16/35: PR: MPH-21
Posted by hb...@apache.org.
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 8fa128841df109d13aecc8dd0714097dd46c8da2
Author: Kenney Westerhof <ke...@apache.org>
AuthorDate: Fri Jan 19 12:05:46 2007 +0000
PR: MPH-21
When help:effective-pom is called from within a pom,
only print out that pom's effective pom.
Added check to only dump all poms if the ${project} is the head of
the reactor list to enforce proper aggregator behaviour.
TODO: maybe this needs an update: find the current project
in the reactor projects, then dump that pom, and find all
modules recursively and dump those, so you can dump a sub-tree
of the reactor, when you run the mojo from the lifecycle.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@497785 13f79535-47bb-0310-9956-ffa450edef68
---
.../maven/plugins/help/EffectivePomMojo.java | 26 +++++++++++++++++-----
1 file changed, 21 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
index 2e3236d..da22d31 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
@@ -39,6 +39,12 @@ import java.util.List;
public class EffectivePomMojo
extends AbstractMojo
{
+ /**
+ * @parameter expression="${project}"
+ * @required
+ * @readonly
+ */
+ private MavenProject project;
/**
* The projects in the current build. The effective-POM for
@@ -64,13 +70,23 @@ public class EffectivePomMojo
throws MojoExecutionException
{
StringBuffer message = new StringBuffer();
-
- for ( Iterator it = projects.iterator(); it.hasNext(); )
+
+ if ( projects.get( 0 ).equals( project ) )
+ {
+ // this is normal in aggregation mode.
+
+ for ( Iterator it = projects.iterator(); it.hasNext(); )
+ {
+ MavenProject project = (MavenProject) it.next();
+
+ getEffectivePom( project, message );
+
+ message.append( "\n\n" );
+ }
+ }
+ else
{
- MavenProject project = (MavenProject) it.next();
-
getEffectivePom( project, message );
-
message.append( "\n\n" );
}
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 09/35: use inheritence and make all the site
appearances consistent
Posted by hb...@apache.org.
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 cae3fb03142f6dd2083f0b572c13f781d8a44fdb
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Mon Oct 23 00:51:59 2006 +0000
use inheritence and make all the site appearances consistent
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@466898 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/site.xml | 22 +---------------------
1 file changed, 1 insertion(+), 21 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index 2a9ef4d..c7bf522 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -18,30 +18,10 @@
*/
-->
-<project name="Maven Help Plugin">
- <bannerLeft>
- <name>Maven 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>
+<project>
<body>
- <links>
- <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
- </links>
-
- <menu name="Overview">
- <item name="Introduction" href="index.html"/>
- <item name="Goals" href="plugin-info.html"/>
- <item name="How To Use" href="usage.html"/>
- <!--item name="FAQs" href="faq.html"/-->
- </menu>
-
<menu name="Examples">
<item name="Configuring Describe Mojo" href="/examples/describe-configuration.html"/>
</menu>
- ${reports}
</body>
</project>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 02/35: [maven-release-plugin] prepare for next
development iteration
Posted by hb...@apache.org.
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 5cde901a4697b1e7a71bc948df1f133b414ef6ab
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Sun May 7 03:32:36 2006 +0000
[maven-release-plugin] prepare for next development iteration
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@400408 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index 3dbfbb0..4d5f7a1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -8,7 +8,7 @@
<artifactId>maven-help-plugin</artifactId>
<packaging>maven-plugin</packaging>
<name>Maven Help Plugin</name>
- <version>2.0.1</version>
+ <version>2.0.2-SNAPSHOT</version>
<description>
The Maven Help plugin provides goals aimed at helping to make sense out of
the build environment. It includes the ability to view the effective
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 14/35: o updating to latest released parent
Posted by hb...@apache.org.
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 d8fce5b1e767ee4e81cb42bfe4f499f0c4f3ded6
Author: Jason van Zyl <jv...@apache.org>
AuthorDate: Tue Dec 26 04:31:00 2006 +0000
o updating to latest released parent
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@490244 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/pom.xml b/pom.xml
index d8d0942..a01b02c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,8 +1,8 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd' xmlns='http://maven.apache.org/POM/4.0.0'>
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>6</version>
+ <version>7</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
@@ -64,3 +64,4 @@
</plugins>
</reporting>
</project>
+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 21/35: Added ignores
Posted by hb...@apache.org.
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 72c531dc410089678ba72e41ef958e9d6b61fdaf
Author: Mark Hobson <ma...@apache.org>
AuthorDate: Fri Jun 15 11:34:44 2007 +0000
Added ignores
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@547635 13f79535-47bb-0310-9956-ffa450edef68
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 15/35: - move plugin-plugin out of 'reporting'
for plugins. It's a required part of the site,
and does not cause any issues with the reactor or site generation - update
to snapshots
Posted by hb...@apache.org.
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 e22d0e413fa96a05675ababf6223571858d7d6ce
Author: Brett Leslie Porter <br...@apache.org>
AuthorDate: Tue Jan 9 10:30:16 2007 +0000
- move plugin-plugin out of 'reporting' for plugins. It's a required part of the site, and does not cause any issues with the reactor or site generation
- update to snapshots
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@494359 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index a01b02c..fdc0b2e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>7</version>
+ <version>8-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 05/35: PR: MPH-17
Posted by hb...@apache.org.
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 55fb64bfe8a01da9ba8664cf6695d2f1a8296036
Author: Maria Odea B. Ching <oc...@apache.org>
AuthorDate: Mon Jul 10 07:17:33 2006 +0000
PR: MPH-17
Revised existing docs to conform with the standard documentation. Added additional docs. Updated pom and site.xml. Also added javadocs.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@420452 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 15 ++-
.../maven/plugins/help/ActiveProfilesMojo.java | 53 +++++---
.../apache/maven/plugins/help/DescribeMojo.java | 140 ++++++++++++++++++++-
.../maven/plugins/help/EffectivePomMojo.java | 43 ++++---
.../maven/plugins/help/EffectiveSettingsMojo.java | 8 +-
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/apt/examples/describe-configuration.apt | 62 +++++++++
src/site/apt/index.apt | 42 +++++++
src/site/apt/usage.apt | 78 ++++++++++++
src/site/fml/faq.fml | 14 +++
src/site/site.xml | 16 ++-
14 files changed, 428 insertions(+), 217 deletions(-)
diff --git a/pom.xml b/pom.xml
index f710ffd..a8022c8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
@@ -16,6 +16,9 @@
have been applied, as well as a describe a particular plugin goal to give usage information.
</description>
<inceptionYear>2001</inceptionYear>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
@@ -43,4 +46,12 @@
<version>2.0</version>
</dependency>
</dependencies>
-</project>
\ No newline at end of file
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </reporting>
+</project>
diff --git a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
index 2a9a251..05712b4 100644
--- a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
@@ -1,21 +1,7 @@
package org.apache.maven.plugins.help;
-import org.apache.maven.model.Profile;
-import org.apache.maven.plugin.AbstractMojo;
-import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugin.logging.Log;
-import org.apache.maven.project.MavenProject;
-
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.Writer;
-import java.util.Date;
-import java.util.Iterator;
-import java.util.List;
-
/*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 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.
@@ -30,7 +16,22 @@ import java.util.List;
* limitations under the License.
*/
-/** Lists the profiles which are currently active for this build.
+import org.apache.maven.model.Profile;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.logging.Log;
+import org.apache.maven.project.MavenProject;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.Writer;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * Lists the profiles which are currently active for this build.
*
* @goal active-profiles
* @aggregator
@@ -55,6 +56,9 @@ public class ActiveProfilesMojo extends AbstractMojo
*/
private File output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
@@ -80,6 +84,12 @@ public class ActiveProfilesMojo extends AbstractMojo
}
}
+ /**
+ * Method for writing the output file of the active profiles information.
+ *
+ * @param message the output to be written to the file
+ * @throws MojoExecutionException
+ */
private void writeFile( StringBuffer message )
throws MojoExecutionException
{
@@ -122,6 +132,12 @@ public class ActiveProfilesMojo extends AbstractMojo
}
}
+ /**
+ * Method to get the active profiles for the project
+ *
+ * @param project the current project
+ * @param message the object where the information will be appended to
+ */
private void getActiveProfileStatement( MavenProject project, StringBuffer message )
{
List profiles = project.getActiveProfiles();
@@ -153,6 +169,11 @@ public class ActiveProfilesMojo extends AbstractMojo
message.append( "\n" );
}
+ /**
+ * Setter method for the list of projects.
+ *
+ * @param projects
+ */
public final void setProjects( List projects )
{
this.projects = projects;
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index c3dd2f3..c6e5e0d 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -1,7 +1,7 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 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.
@@ -190,6 +190,9 @@ public class DescribeMojo
*/
private boolean full;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException, MojoFailureException
{
@@ -225,6 +228,12 @@ public class DescribeMojo
writeDescription( descriptionBuffer );
}
+ /**
+ * Method to write the mojo description into the output file
+ *
+ * @param descriptionBuffer contains the description to be written to the file
+ * @throws MojoExecutionException
+ */
private void writeDescription( StringBuffer descriptionBuffer )
throws MojoExecutionException
{
@@ -266,6 +275,14 @@ public class DescribeMojo
}
}
+ /**
+ * Method for retrieving the description of the plugin
+ *
+ * @param pi holds information of the plugin whose description is to be retrieved
+ * @return a PluginDescriptor where the plugin description is to be retrieved
+ * @throws MojoExecutionException
+ * @throws MojoFailureException
+ */
private PluginDescriptor lookupPluginDescriptor( PluginInfo pi )
throws MojoExecutionException, MojoFailureException
{
@@ -356,6 +373,12 @@ public class DescribeMojo
return descriptor;
}
+ /**
+ * Method for parsing the plugin parameter
+ *
+ * @param pi contains information about the plugin whose description is to be retrieved
+ * @throws MojoFailureException
+ */
private void parsePluginLookupInfo( PluginInfo pi )
throws MojoFailureException
{
@@ -405,6 +428,12 @@ public class DescribeMojo
}
}
+ /**
+ * Method for retrieving the plugin description
+ *
+ * @param pd contains the plugin description
+ * @param buffer contains the information to be displayed or printed
+ */
private void describePlugin( PluginDescriptor pd, StringBuffer buffer )
{
String name = pd.getName();
@@ -446,6 +475,12 @@ public class DescribeMojo
}
}
+ /**
+ * Convenience method for formatting the description.
+ *
+ * @param description the plugin description
+ * @return a String of the formatted plugin description
+ */
private String formatDescription( String description )
{
if ( description == null )
@@ -461,6 +496,12 @@ public class DescribeMojo
return result;
}
+ /**
+ * Convenience method for putting the appropriate value to the plugin description
+ *
+ * @param messagePart the plugin description
+ * @param buffer contains information to be printed or displayed
+ */
private void prettyAppend( String messagePart, StringBuffer buffer )
{
if ( messagePart != null && messagePart.length() > 0 )
@@ -473,6 +514,12 @@ public class DescribeMojo
}
}
+ /**
+ * Displays information about the plugin mojo
+ *
+ * @param md contains the description of the plugin mojo
+ * @param buffer the displayed output
+ */
private void describeMojo( MojoDescriptor md, StringBuffer buffer )
{
String line = "\n===============================================";
@@ -487,6 +534,13 @@ public class DescribeMojo
buffer.append( "\n\n" );
}
+ /**
+ * Displays detailed information about the plugin mojo
+ *
+ * @param md contains the description of the plugin mojo
+ * @param buffer contains information to be printed or displayed
+ * @param fullDescription specifies whether all the details about the plugin mojo is to be displayed
+ */
private void describeMojoGuts( MojoDescriptor md, StringBuffer buffer, boolean fullDescription )
{
buffer.append( "\nDescription:\n\n" );
@@ -541,6 +595,12 @@ public class DescribeMojo
}
}
+ /**
+ * Method for displaying the component requirements of the plugin mojo
+ *
+ * @param md contains the description of the plugin mojo
+ * @param buffer contains information to be printed or displayed
+ */
private void describeMojoRequirements( MojoDescriptor md, StringBuffer buffer )
{
buffer.append( "\n" );
@@ -580,6 +640,12 @@ public class DescribeMojo
}
}
+ /**
+ * Displays parameter information of the plugin mojo
+ *
+ * @param md contains the description of the plugin mojo
+ * @param buffer contains information to be printed or displayed
+ */
private void describeMojoParameters( MojoDescriptor md, StringBuffer buffer )
{
buffer.append( "\n" );
@@ -647,81 +713,145 @@ public class DescribeMojo
}
}
+ /**
+ *
+ * @return a String of the plugin parameter value
+ */
public final String getPlugin()
{
return plugin;
}
+ /**
+ *
+ * @param plugin the plugin value to be set
+ */
public final void setPlugin( String plugin )
{
this.plugin = plugin;
}
+ /**
+ *
+ * @return a PluginManager object
+ */
public final PluginManager getPluginManager()
{
return pluginManager;
}
+ /**
+ *
+ * @param pluginManager the plugin manager to be set
+ */
public final void setPluginManager( PluginManager pluginManager )
{
this.pluginManager = pluginManager;
}
+ /**
+ *
+ * @return a String that contains the artifactId
+ */
public final String getArtifactId()
{
return artifactId;
}
+ /**
+ *
+ * @param artifactId the artifactId to be set
+ */
public final void setArtifactId( String artifactId )
{
this.artifactId = artifactId;
}
+ /**
+ *
+ * @return a String that contains the groupId
+ */
public final String getGroupId()
{
return groupId;
}
+ /**
+ *
+ * @param groupId the groupId value to be set
+ */
public final void setGroupId( String groupId )
{
this.groupId = groupId;
}
+ /**
+ *
+ * @return an ArtifactRepository object of the local repository
+ */
public final ArtifactRepository getLocalRepository()
{
return localRepository;
}
+ /**
+ *
+ * @param localRepository the local repository value to be set
+ */
public final void setLocalRepository( ArtifactRepository localRepository )
{
this.localRepository = localRepository;
}
+ /**
+ *
+ * @return a String of the mojo parameter value
+ */
public final String getMojo()
{
return mojo;
}
+ /**
+ *
+ * @param mojo the mojo parameter value to be set
+ */
public final void setMojo( String mojo )
{
this.mojo = mojo;
}
+ /**
+ *
+ * @return a File object where the description will be written to
+ */
public final File getOutput()
{
return output;
}
+ /**
+ *
+ * @param output the output file value to be set
+ */
public final void setOutput( File output )
{
this.output = output;
}
+ /**
+ *
+ * @return a MavenProject object of the current build
+ */
public final MavenProject getProject()
{
return project;
}
+ /**
+ *
+ * @param project the project value to be set
+ */
public final void setProject( MavenProject project )
{
this.project = project;
@@ -737,11 +867,19 @@ public class DescribeMojo
this.settings = settings;
}
+ /**
+ *
+ * @return a String that contains the value of the version parameter
+ */
public final String getVersion()
{
return version;
}
+ /**
+ *
+ * @param version the version parameter value to be set
+ */
public final void setVersion( String version )
{
this.version = version;
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
index 41f8325..2e3236d 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
@@ -1,21 +1,7 @@
package org.apache.maven.plugins.help;
-import org.apache.maven.model.Model;
-import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
-import org.apache.maven.plugin.AbstractMojo;
-import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.project.MavenProject;
-
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.StringWriter;
-import java.util.Date;
-import java.util.Iterator;
-import java.util.List;
-
/*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 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.
@@ -30,7 +16,22 @@ import java.util.List;
* limitations under the License.
*/
-/** Display the effective POM for this build, with the active profiles factored in.
+import org.apache.maven.model.Model;
+import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.project.MavenProject;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * Display the effective POM for this build, with the active profiles factored in.
*
* @goal effective-pom
* @aggregator
@@ -56,6 +57,9 @@ public class EffectivePomMojo
*/
private File output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
@@ -122,6 +126,13 @@ public class EffectivePomMojo
}
}
+ /**
+ * Method for displaying the effective pom information of the current build
+ *
+ * @param project the project of the current build
+ * @param message the information to be displayed
+ * @throws MojoExecutionException
+ */
private void getEffectivePom( MavenProject project, StringBuffer message )
throws MojoExecutionException
{
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
index adeb2bf..21501ff 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
@@ -1,7 +1,7 @@
package org.apache.maven.plugins.help;
/*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 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.
@@ -26,7 +26,8 @@ import java.io.FileWriter;
import java.io.IOException;
import java.io.StringWriter;
-/** Print out the calculated settings for this project, given any profile enhancement and
+/**
+ * Print out the calculated settings for this project, given any profile enhancement and
* the inheritance of the global settings into the user-level settings.
*
* @goal effective-settings
@@ -53,6 +54,9 @@ public class EffectiveSettingsMojo
*/
private String output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
diff --git a/src/site/apt/active-profiles-mojo.apt b/src/site/apt/active-profiles-mojo.apt
deleted file mode 100644
index 75d15be..0000000
--- a/src/site/apt/active-profiles-mojo.apt
+++ /dev/null
@@ -1,27 +0,0 @@
- ---
- Maven 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
deleted file mode 100644
index 1af7688..0000000
--- a/src/site/apt/describe-mojo.apt
+++ /dev/null
@@ -1,93 +0,0 @@
- ---
- 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=help
-+---+
-
-*Examples
-
- [[1]] To display a brief summary of the entire help plugin, using the
- prefix for plugin lookup:
-
-+---+
- mvn help:describe -Dplugin=help
-+---+
-
- [[2]] To display a full summary of only the describe mojo, again using the
- prefix to lookup the plugin:
-
-+---+
- mvn help:describe -Dplugin=help -Dmojo=describe -Dfull=true
-+---+
-
- [[3]] To display the most information available for the entire help
- plugin, and avoid any confusion about which plugin might be resolved
- for a particular prefix:
-
-+---+
- mvn help:describe -Dfull=true \
- -DgroupId=org.apache.maven.plugins \
- -DartifactId=maven-help-plugin
-+---+
diff --git a/src/site/apt/effective-pom-mojo.apt b/src/site/apt/effective-pom-mojo.apt
deleted file mode 100644
index 5f4e3c2..0000000
--- a/src/site/apt/effective-pom-mojo.apt
+++ /dev/null
@@ -1,28 +0,0 @@
- ---
- Maven 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
deleted file mode 100644
index d63c6c1..0000000
--- a/src/site/apt/effective-settings-mojo.apt
+++ /dev/null
@@ -1,26 +0,0 @@
- ---
- Maven 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/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt
new file mode 100644
index 0000000..e225d38
--- /dev/null
+++ b/src/site/apt/examples/describe-configuration.apt
@@ -0,0 +1,62 @@
+ ------
+ Configuring Describe Mojo
+ ------
+ John Casey
+ Maria Odea Ching
+ ------
+ 10 July 2006
+ ------
+
+Configuring Describe Mojo
+
+ Below are other configuration examples for the Describe mojo.
+
+* The <<<plugin>>> Parameter
+
+ The <<<plugin>>> 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:
+
++---+
+mvn help:describe -DgroupId=org.somewhere
+ -DartifactId=some-plugin -Dversion=0.0.0
++---+
+
+ the use of the plugin parameter allows this:
+
++---+
+mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
++---+
+
+ On the other hand, the plugin parameter also offers the option to specify a plugin by its prefix, like this:
+
++---+
+mvn help:describe -Dplugin=help
++---+
+
+* The <<<mojo>>> Parameter
+
+ You can use the <<<mojo>>> parameter of the Describe Mojo to show or display relative information about the particular mojo
+ of the plugin you specified.
+
+ For example, when you execute the following command:
+
++-----+
+mvn help:describe -Dmojo=describe -DgroupId=org.apache.maven.plugins
+ -DartifactId=maven-help-plugin
++-----+
+
+ This would display brief information relative to the Describe Mojo only.
+
+* The <<<full>>> Parameter
+
+ If you want to show or display detailed information about the mojo, you can use the <<<full>>> parameter, as
+ shown below:
+
++-----+
+mvn help:describe -Dmojo=describe -DgroupId=org.apache.maven.plugins
+ -DartifactId=maven-help-plugin -Dfull=true
++-----+
+
+ This would display information such as the mojo implementation, its parameters and component requirements, among others.
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
new file mode 100644
index 0000000..e2307c8
--- /dev/null
+++ b/src/site/apt/index.apt
@@ -0,0 +1,42 @@
+ ------
+ Introduction
+ ------
+ Maria Odea Ching
+ ------
+ 7 July 2006
+ ------
+
+
+Maven 2 Help Plugin
+
+ The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description
+ of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom
+ and effective settings of the current build, and the profiles applied to the current project being built.
+
+* Goals Overview
+
+ The Help plugin has 4 goals:
+
+ * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
+
+ * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
+ the groupId and artifactId or the plugin prefix of the plugin to be specified.
+
+ * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
+ profiles factored in.
+
+ * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any
+ profile enhancement and the inheritance of the global settings into the user-level settings.
+
+* Usage
+
+ Instructions on how to use the Help Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Help plugin, you can take a look into the
+ following example(s):
+
+ * {{{examples/describe-configuration.html}Configuring Describe Mojo}}
+
+
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
new file mode 100644
index 0000000..8af5102
--- /dev/null
+++ b/src/site/apt/usage.apt
@@ -0,0 +1,78 @@
+ ------
+ Usage
+ ------
+ John Casey
+ Maria Odea Ching
+ ------
+ 10 July 2006
+ ------
+
+Usage
+
+ Below are the different goals and configuration 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.
+
+ You can execute this mojo using the following command:
+
++-----+
+mvn help:active-profiles -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ 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
++-----+
+
+ or
+
++-----+
+mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
++-----+
+
+ (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,
+ 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 executedd using the following command:
+
++-----+
+mvn help:effective-profiles -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ The mojo can be executedd using the following command:
+
++-----+
+mvn help:effective-settings -Doutput=/path/to/file
++-----+
+
+
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
new file mode 100644
index 0000000..38e68a7
--- /dev/null
+++ b/src/site/fml/faq.fml
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="What is the Maven 2 Help Plugin">
+ <question>What is the Maven 2 Help Plugin?</question>
+ <answer>
+ <p>
+ The Maven 2 Help Plugin can be used to get relative information about a particular project. You can use it
+ to get a description of a specific plugin, or get the effective settings or effective pom of the current project build.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index e58efad..5149594 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -2,7 +2,7 @@
<!--
/*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 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.
@@ -32,11 +32,15 @@
<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 name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="How To Use" href="usage.html"/>
+ <item name="FAQs" href="faq.html"/>
+ </menu>
+
+ <menu name="Examples">
+ <item name="Configuring Describe Mojo" href="/examples/describe-configuration.html"/>
</menu>
${reports}
</body>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 17/35: o Set EOL style to native.
Posted by hb...@apache.org.
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 cfb5f16872975bcc0eb9dc07aa19c2bf5271bf22
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Thu Mar 1 21:18:56 2007 +0000
o Set EOL style to native.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@513503 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/index.apt | 88 ++++++++++++------------
src/site/apt/usage.apt | 182 ++++++++++++++++++++++++-------------------------
2 files changed, 135 insertions(+), 135 deletions(-)
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index b0be4ce..4562697 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -1,44 +1,44 @@
- ------
- Introduction
- ------
- Maria Odea Ching
- ------
- 7 July 2006
- ------
-
-
-Maven 2 Help Plugin
-
- The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description
- of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom
- and effective settings of the current build, and the profiles applied to the current project being built.
-
-* Goals Overview
-
- The Help plugin has the following goals:
-
- * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
-
- * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project.
-
- * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
- the groupId and artifactId or the plugin prefix of the plugin to be specified.
-
- * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
- profiles factored in.
-
- * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any
- profile enhancement and the inheritance of the global settings into the user-level settings.
-
-* Usage
-
- Instructions on how to use the Help Plugin can be found {{{usage.html}here}}.
-
-* Examples
-
- To provide you with better understanding on some usages of the Help plugin, you can take a look into the
- following example(s):
-
- * {{{examples/describe-configuration.html}Configuring Describe Mojo}}
-
-
+ ------
+ Introduction
+ ------
+ Maria Odea Ching
+ ------
+ 7 July 2006
+ ------
+
+
+Maven 2 Help Plugin
+
+ The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description
+ of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom
+ and effective settings of the current build, and the profiles applied to the current project being built.
+
+* Goals Overview
+
+ The Help plugin has the following goals:
+
+ * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
+
+ * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project.
+
+ * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
+ the groupId and artifactId or the plugin prefix of the plugin to be specified.
+
+ * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
+ profiles factored in.
+
+ * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any
+ profile enhancement and the inheritance of the global settings into the user-level settings.
+
+* Usage
+
+ Instructions on how to use the Help Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Help plugin, you can take a look into the
+ following example(s):
+
+ * {{{examples/describe-configuration.html}Configuring Describe Mojo}}
+
+
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index abb4e11..1580d48 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -1,91 +1,91 @@
- ------
- Usage
- ------
- John Casey
- Maria Odea Ching
- ------
- 10 July 2006
- ------
-
-Usage
-
- Below are the different goals and configuration 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.
-
- You can execute this mojo using the following command:
-
-+-----+
-mvn help:active-profiles -Doutput=/path/to/file
-+-----+
-
-* The <<<help:dependencies>>> Mojo
-
- The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
- It will output the resolved tree of dependencies that the Maven build process actually uses.
-
- Optionally, the output parameter can be specified to divert this output to a file.
-
- You can execute this mojo using the following command:
-
-+-----+
-mvn help:dependencies -Doutput=/path/to/file
-+-----+
-
-* 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.
-
- Optionally, the output parameter can be specified to divert this output to a file.
-
- 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
-+-----+
-
- or
-
-+-----+
-mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
-+-----+
-
- (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,
- 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 executedd using the following command:
-
-+-----+
-mvn help:effective-profiles -Doutput=/path/to/file
-+-----+
-
-* 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.
-
- Optionally, the output parameter can be specified to divert this output to a file.
-
- The mojo can be executedd using the following command:
-
-+-----+
-mvn help:effective-settings -Doutput=/path/to/file
-+-----+
-
-
+ ------
+ Usage
+ ------
+ John Casey
+ Maria Odea Ching
+ ------
+ 10 July 2006
+ ------
+
+Usage
+
+ Below are the different goals and configuration 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.
+
+ You can execute this mojo using the following command:
+
++-----+
+mvn help:active-profiles -Doutput=/path/to/file
++-----+
+
+* The <<<help:dependencies>>> Mojo
+
+ The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
+ It will output the resolved tree of dependencies that the Maven build process actually uses.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ You can execute this mojo using the following command:
+
++-----+
+mvn help:dependencies -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ 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
++-----+
+
+ or
+
++-----+
+mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
++-----+
+
+ (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,
+ 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 executedd using the following command:
+
++-----+
+mvn help:effective-profiles -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ The mojo can be executedd using the following command:
+
++-----+
+mvn help:effective-settings -Doutput=/path/to/file
++-----+
+
+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 12/35: update maven-dependency-tree dependency
and parent version
Posted by hb...@apache.org.
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 308d19fc32174a3356c660a60f9ed7cec4048138
Author: Fabrizio Giustina <fg...@apache.org>
AuthorDate: Wed Dec 13 20:44:12 2006 +0000
update maven-dependency-tree dependency and parent version
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@486833 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/pom.xml b/pom.xml
index 7fdf5ae..f0d4d9d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>4-SNAPSHOT</version>
+ <version>6-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-help-plugin</artifactId>
@@ -52,7 +52,7 @@
<dependency>
<groupId>org.apache.maven.shared</groupId>
<artifactId>maven-dependency-tree</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>1.0-alpha-2</version>
</dependency>
</dependencies>
<reporting>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 33/35: o Add a proper FAQ.
Posted by hb...@apache.org.
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 07ab326ddae9487c4240e7ce3efee96fc52f0975
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 23:50:21 2007 +0000
o Add a proper FAQ.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593994 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/fml/faq.fml | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index e9153bc..e64201c 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -21,10 +21,12 @@ under the License.
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="1">
- <question>1</question>
+ <faq id="Why aren't profiles from the parent pom included?">
+ <question>Why aren't profiles from the parent pom included?</question>
<answer>
- <p>
+ <p>
+ As of version 2.0.2 they are.
+ See <a href="http://jira.codehaus.org/browse/MPH-16">MPH-16</a> for more info.
</p>
</answer>
</faq>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 06/35: Commented out FAQ page.
Posted by hb...@apache.org.
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 b524e0586744fbccf6dd4311cb604a4929d295ae
Author: Maria Odea B. Ching <oc...@apache.org>
AuthorDate: Mon Jul 10 08:43:46 2006 +0000
Commented out FAQ page.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@420461 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/fml/faq.fml | 8 +++-----
src/site/site.xml | 2 +-
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index 38e68a7..17be3dd 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -1,12 +1,10 @@
<?xml version="1.0"?>
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="What is the Maven 2 Help Plugin">
- <question>What is the Maven 2 Help Plugin?</question>
+ <faq id="1">
+ <question>1</question>
<answer>
- <p>
- The Maven 2 Help Plugin can be used to get relative information about a particular project. You can use it
- to get a description of a specific plugin, or get the effective settings or effective pom of the current project build.
+ <p>
</p>
</answer>
</faq>
diff --git a/src/site/site.xml b/src/site/site.xml
index 5149594..2a9ef4d 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -36,7 +36,7 @@
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="How To Use" href="usage.html"/>
- <item name="FAQs" href="faq.html"/>
+ <!--item name="FAQs" href="faq.html"/-->
</menu>
<menu name="Examples">
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 28/35: o Remove unused but declared dependency.
Posted by hb...@apache.org.
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 5fde6fd48317d86c8731a4e0c7417a2e649c2a26
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 22:23:21 2007 +0000
o Remove unused but declared dependency.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593980 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 5 -----
1 file changed, 5 deletions(-)
diff --git a/pom.xml b/pom.xml
index 1e539b0..775cabd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -70,11 +70,6 @@ under the License.
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
- <artifactId>maven-plugin-tools-api</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven</groupId>
<artifactId>maven-project</artifactId>
<version>2.0</version>
</dependency>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 11/35: MPH-14 Add a mojo to print the
dependency tree Submitted by Mark Hobson
Posted by hb...@apache.org.
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 9ad83325fdef1871368a655c2db5d13479a687bd
Author: Fabrizio Giustina <fg...@apache.org>
AuthorDate: Fri Dec 8 11:24:08 2006 +0000
MPH-14 Add a mojo to print the dependency tree
Submitted by Mark Hobson
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@483937 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 5 +
.../maven/plugins/help/DependenciesMojo.java | 258 +++++++++++++++++++++
src/site/apt/index.apt | 86 +++----
src/site/apt/usage.apt | 169 +++++++-------
4 files changed, 398 insertions(+), 120 deletions(-)
diff --git a/pom.xml b/pom.xml
index 2b0a232..7fdf5ae 100644
--- a/pom.xml
+++ b/pom.xml
@@ -49,6 +49,11 @@
<artifactId>maven-plugin-descriptor</artifactId>
<version>2.0</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.maven.shared</groupId>
+ <artifactId>maven-dependency-tree</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </dependency>
</dependencies>
<reporting>
<plugins>
diff --git a/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java b/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java
new file mode 100644
index 0000000..cffb119
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java
@@ -0,0 +1,258 @@
+/*
+ * Copyright 2006 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.
+ */
+package org.apache.maven.plugins.help;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.StringReader;
+import java.util.Iterator;
+
+import org.apache.maven.artifact.factory.ArtifactFactory;
+import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
+import org.apache.maven.artifact.repository.ArtifactRepository;
+import org.apache.maven.artifact.resolver.ArtifactCollector;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.shared.dependency.tree.DependencyNode;
+import org.apache.maven.shared.dependency.tree.DependencyTree;
+import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
+import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;
+
+/**
+ * Displays the dependency tree for this project.
+ *
+ * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
+ * @version $Id$
+ * @goal dependencies
+ * @requiresDependencyResolution test
+ */
+public class DependenciesMojo extends AbstractMojo
+{
+ // constants --------------------------------------------------------------
+
+ /**
+ * The indentation string to use when serialising the dependency tree.
+ */
+ private static final String INDENT = " ";
+
+ /**
+ * The newline string to use when serialising the dependency tree.
+ */
+ private static final String NEWLINE = System.getProperty( "line.separator" );
+
+ // fields -----------------------------------------------------------------
+
+ /**
+ * The Maven project.
+ *
+ * @parameter expression="${project}"
+ * @required
+ * @readonly
+ */
+ private MavenProject project;
+
+ /**
+ * The artifact respository to use.
+ *
+ * @parameter expression="${localRepository}"
+ * @required
+ * @readonly
+ */
+ private ArtifactRepository localRepository;
+
+ /**
+ * The artifact factory to use.
+ *
+ * @component
+ */
+ private ArtifactFactory artifactFactory;
+
+ /**
+ * The artifact metadata source to use.
+ *
+ * @component
+ */
+ private ArtifactMetadataSource artifactMetadataSource;
+
+ /**
+ * The artifact collector to use.
+ *
+ * @component
+ */
+ private ArtifactCollector artifactCollector;
+
+ /**
+ * The dependency tree builder to use.
+ *
+ * @component
+ */
+ private DependencyTreeBuilder dependencyTreeBuilder;
+
+ /**
+ * If specified, this parameter will cause the dependency tree to be written to the path specified, instead of
+ * writing to the console.
+ *
+ * @parameter expression="${output}"
+ */
+ private File output;
+
+ // Mojo methods -----------------------------------------------------------
+
+ /*
+ * @see org.apache.maven.plugin.Mojo#execute()
+ */
+ public void execute() throws MojoExecutionException, MojoFailureException
+ {
+ try
+ {
+ DependencyTree dependencyTree =
+ dependencyTreeBuilder.buildDependencyTree( project, localRepository, artifactFactory,
+ artifactMetadataSource, artifactCollector );
+
+ String dependencyTreeString = serialiseDependencyTree( dependencyTree );
+
+ if ( output != null )
+ {
+ write( dependencyTreeString, output );
+
+ getLog().info( "Wrote dependency tree to: " + output );
+ }
+ else
+ {
+ log( dependencyTreeString );
+ }
+ }
+ catch ( DependencyTreeBuilderException exception )
+ {
+ throw new MojoExecutionException( "Cannot build project dependency tree", exception );
+ }
+ catch ( IOException exception )
+ {
+ throw new MojoExecutionException( "Cannot serialise project dependency tree", exception );
+ }
+ }
+
+ // private methods --------------------------------------------------------
+
+ /**
+ * Serialises the specified dependency tree to a string.
+ *
+ * @param tree
+ * the dependency tree to serialise
+ * @return the serialised dependency tree
+ */
+ private String serialiseDependencyTree( DependencyTree tree )
+ {
+ StringBuffer buffer = new StringBuffer();
+
+ serialiseDependencyNode( tree.getRootNode(), buffer );
+
+ return buffer.toString();
+ }
+
+ /**
+ * Serialises the specified dependency node and it's children to the specified string buffer.
+ *
+ * @param node
+ * the dependency node to log
+ * @param buffer
+ * the string buffer to serialise to
+ */
+ private void serialiseDependencyNode( DependencyNode node, StringBuffer buffer )
+ {
+ // serialise node
+
+ for ( int i = 0; i < node.getDepth(); i++ )
+ {
+ buffer.append( INDENT );
+ }
+
+ buffer.append( node.getArtifact() ).append( NEWLINE );
+
+ // serialise children
+
+ for ( Iterator iterator = node.getChildren().iterator(); iterator.hasNext(); )
+ {
+ DependencyNode child = (DependencyNode) iterator.next();
+
+ serialiseDependencyNode( child, buffer );
+ }
+ }
+
+ /**
+ * Writes the specified string to the specified file.
+ *
+ * @param string
+ * the string to write
+ * @param file
+ * the file to write to
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ private void write( String string, File file ) throws IOException
+ {
+ output.getParentFile().mkdirs();
+
+ FileWriter writer = null;
+
+ try
+ {
+ writer = new FileWriter( output );
+
+ writer.write( string );
+ }
+ finally
+ {
+ if ( writer != null )
+ {
+ try
+ {
+ writer.close();
+ }
+ catch ( IOException exception )
+ {
+ getLog().error( "Cannot close file", exception );
+ }
+ }
+ }
+ }
+
+ /**
+ * Writes the specified string to the log at info level.
+ *
+ * @param string
+ * the string to write
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ private void log( String string ) throws IOException
+ {
+ BufferedReader reader = new BufferedReader( new StringReader( string ) );
+
+ String line;
+
+ while ( ( line = reader.readLine() ) != null )
+ {
+ getLog().info( line );
+ }
+
+ reader.close();
+ }
+}
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index e2307c8..b0be4ce 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -1,42 +1,44 @@
- ------
- Introduction
- ------
- Maria Odea Ching
- ------
- 7 July 2006
- ------
-
-
-Maven 2 Help Plugin
-
- The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description
- of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom
- and effective settings of the current build, and the profiles applied to the current project being built.
-
-* Goals Overview
-
- The Help plugin has 4 goals:
-
- * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
-
- * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
- the groupId and artifactId or the plugin prefix of the plugin to be specified.
-
- * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
- profiles factored in.
-
- * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any
- profile enhancement and the inheritance of the global settings into the user-level settings.
-
-* Usage
-
- Instructions on how to use the Help Plugin can be found {{{usage.html}here}}.
-
-* Examples
-
- To provide you with better understanding on some usages of the Help plugin, you can take a look into the
- following example(s):
-
- * {{{examples/describe-configuration.html}Configuring Describe Mojo}}
-
-
+ ------
+ Introduction
+ ------
+ Maria Odea Ching
+ ------
+ 7 July 2006
+ ------
+
+
+Maven 2 Help Plugin
+
+ The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description
+ of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom
+ and effective settings of the current build, and the profiles applied to the current project being built.
+
+* Goals Overview
+
+ The Help plugin has the following goals:
+
+ * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
+
+ * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project.
+
+ * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
+ the groupId and artifactId or the plugin prefix of the plugin to be specified.
+
+ * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
+ profiles factored in.
+
+ * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any
+ profile enhancement and the inheritance of the global settings into the user-level settings.
+
+* Usage
+
+ Instructions on how to use the Help Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Help plugin, you can take a look into the
+ following example(s):
+
+ * {{{examples/describe-configuration.html}Configuring Describe Mojo}}
+
+
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 8af5102..abb4e11 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -1,78 +1,91 @@
- ------
- Usage
- ------
- John Casey
- Maria Odea Ching
- ------
- 10 July 2006
- ------
-
-Usage
-
- Below are the different goals and configuration 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.
-
- You can execute this mojo using the following command:
-
-+-----+
-mvn help:active-profiles -Doutput=/path/to/file
-+-----+
-
-* 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.
-
- Optionally, the output parameter can be specified to divert this output to a file.
-
- 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
-+-----+
-
- or
-
-+-----+
-mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
-+-----+
-
- (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,
- 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 executedd using the following command:
-
-+-----+
-mvn help:effective-profiles -Doutput=/path/to/file
-+-----+
-
-* 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.
-
- Optionally, the output parameter can be specified to divert this output to a file.
-
- The mojo can be executedd using the following command:
-
-+-----+
-mvn help:effective-settings -Doutput=/path/to/file
-+-----+
-
-
+ ------
+ Usage
+ ------
+ John Casey
+ Maria Odea Ching
+ ------
+ 10 July 2006
+ ------
+
+Usage
+
+ Below are the different goals and configuration 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.
+
+ You can execute this mojo using the following command:
+
++-----+
+mvn help:active-profiles -Doutput=/path/to/file
++-----+
+
+* The <<<help:dependencies>>> Mojo
+
+ The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
+ It will output the resolved tree of dependencies that the Maven build process actually uses.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ You can execute this mojo using the following command:
+
++-----+
+mvn help:dependencies -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ 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
++-----+
+
+ or
+
++-----+
+mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
++-----+
+
+ (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,
+ 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 executedd using the following command:
+
++-----+
+mvn help:effective-profiles -Doutput=/path/to/file
++-----+
+
+* 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.
+
+ Optionally, the output parameter can be specified to divert this output to a file.
+
+ The mojo can be executedd using the following command:
+
++-----+
+mvn help:effective-settings -Doutput=/path/to/file
++-----+
+
+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 20/35: MPH-24: moved tree over to dependency
plugin
Posted by hb...@apache.org.
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 b46eb5c3e5dea5ac0660ae7c12823ed845dc4e75
Author: Brian E Fox <br...@apache.org>
AuthorDate: Thu Jun 7 03:44:00 2007 +0000
MPH-24: moved tree over to dependency plugin
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@545050 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 6 +-
.../maven/plugins/help/DependenciesMojo.java | 258 ---------------------
src/site/apt/index.apt | 3 +-
src/site/apt/usage.apt | 14 +-
4 files changed, 3 insertions(+), 278 deletions(-)
diff --git a/pom.xml b/pom.xml
index e70d609..0f88434 100644
--- a/pom.xml
+++ b/pom.xml
@@ -49,11 +49,6 @@
<artifactId>maven-plugin-descriptor</artifactId>
<version>2.0</version>
</dependency>
- <dependency>
- <groupId>org.apache.maven.shared</groupId>
- <artifactId>maven-dependency-tree</artifactId>
- <version>1.0-alpha-2</version>
- </dependency>
</dependencies>
<reporting>
<plugins>
@@ -65,3 +60,4 @@
</reporting>
</project>
+
diff --git a/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java b/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java
deleted file mode 100644
index cffb119..0000000
--- a/src/main/java/org/apache/maven/plugins/help/DependenciesMojo.java
+++ /dev/null
@@ -1,258 +0,0 @@
-/*
- * Copyright 2006 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.
- */
-package org.apache.maven.plugins.help;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.StringReader;
-import java.util.Iterator;
-
-import org.apache.maven.artifact.factory.ArtifactFactory;
-import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
-import org.apache.maven.artifact.repository.ArtifactRepository;
-import org.apache.maven.artifact.resolver.ArtifactCollector;
-import org.apache.maven.plugin.AbstractMojo;
-import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugin.MojoFailureException;
-import org.apache.maven.project.MavenProject;
-import org.apache.maven.shared.dependency.tree.DependencyNode;
-import org.apache.maven.shared.dependency.tree.DependencyTree;
-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;
-
-/**
- * Displays the dependency tree for this project.
- *
- * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
- * @version $Id$
- * @goal dependencies
- * @requiresDependencyResolution test
- */
-public class DependenciesMojo extends AbstractMojo
-{
- // constants --------------------------------------------------------------
-
- /**
- * The indentation string to use when serialising the dependency tree.
- */
- private static final String INDENT = " ";
-
- /**
- * The newline string to use when serialising the dependency tree.
- */
- private static final String NEWLINE = System.getProperty( "line.separator" );
-
- // fields -----------------------------------------------------------------
-
- /**
- * The Maven project.
- *
- * @parameter expression="${project}"
- * @required
- * @readonly
- */
- private MavenProject project;
-
- /**
- * The artifact respository to use.
- *
- * @parameter expression="${localRepository}"
- * @required
- * @readonly
- */
- private ArtifactRepository localRepository;
-
- /**
- * The artifact factory to use.
- *
- * @component
- */
- private ArtifactFactory artifactFactory;
-
- /**
- * The artifact metadata source to use.
- *
- * @component
- */
- private ArtifactMetadataSource artifactMetadataSource;
-
- /**
- * The artifact collector to use.
- *
- * @component
- */
- private ArtifactCollector artifactCollector;
-
- /**
- * The dependency tree builder to use.
- *
- * @component
- */
- private DependencyTreeBuilder dependencyTreeBuilder;
-
- /**
- * If specified, this parameter will cause the dependency tree to be written to the path specified, instead of
- * writing to the console.
- *
- * @parameter expression="${output}"
- */
- private File output;
-
- // Mojo methods -----------------------------------------------------------
-
- /*
- * @see org.apache.maven.plugin.Mojo#execute()
- */
- public void execute() throws MojoExecutionException, MojoFailureException
- {
- try
- {
- DependencyTree dependencyTree =
- dependencyTreeBuilder.buildDependencyTree( project, localRepository, artifactFactory,
- artifactMetadataSource, artifactCollector );
-
- String dependencyTreeString = serialiseDependencyTree( dependencyTree );
-
- if ( output != null )
- {
- write( dependencyTreeString, output );
-
- getLog().info( "Wrote dependency tree to: " + output );
- }
- else
- {
- log( dependencyTreeString );
- }
- }
- catch ( DependencyTreeBuilderException exception )
- {
- throw new MojoExecutionException( "Cannot build project dependency tree", exception );
- }
- catch ( IOException exception )
- {
- throw new MojoExecutionException( "Cannot serialise project dependency tree", exception );
- }
- }
-
- // private methods --------------------------------------------------------
-
- /**
- * Serialises the specified dependency tree to a string.
- *
- * @param tree
- * the dependency tree to serialise
- * @return the serialised dependency tree
- */
- private String serialiseDependencyTree( DependencyTree tree )
- {
- StringBuffer buffer = new StringBuffer();
-
- serialiseDependencyNode( tree.getRootNode(), buffer );
-
- return buffer.toString();
- }
-
- /**
- * Serialises the specified dependency node and it's children to the specified string buffer.
- *
- * @param node
- * the dependency node to log
- * @param buffer
- * the string buffer to serialise to
- */
- private void serialiseDependencyNode( DependencyNode node, StringBuffer buffer )
- {
- // serialise node
-
- for ( int i = 0; i < node.getDepth(); i++ )
- {
- buffer.append( INDENT );
- }
-
- buffer.append( node.getArtifact() ).append( NEWLINE );
-
- // serialise children
-
- for ( Iterator iterator = node.getChildren().iterator(); iterator.hasNext(); )
- {
- DependencyNode child = (DependencyNode) iterator.next();
-
- serialiseDependencyNode( child, buffer );
- }
- }
-
- /**
- * Writes the specified string to the specified file.
- *
- * @param string
- * the string to write
- * @param file
- * the file to write to
- * @throws IOException
- * if an I/O error occurs
- */
- private void write( String string, File file ) throws IOException
- {
- output.getParentFile().mkdirs();
-
- FileWriter writer = null;
-
- try
- {
- writer = new FileWriter( output );
-
- writer.write( string );
- }
- finally
- {
- if ( writer != null )
- {
- try
- {
- writer.close();
- }
- catch ( IOException exception )
- {
- getLog().error( "Cannot close file", exception );
- }
- }
- }
- }
-
- /**
- * Writes the specified string to the log at info level.
- *
- * @param string
- * the string to write
- * @throws IOException
- * if an I/O error occurs
- */
- private void log( String string ) throws IOException
- {
- BufferedReader reader = new BufferedReader( new StringReader( string ) );
-
- String line;
-
- while ( ( line = reader.readLine() ) != null )
- {
- getLog().info( line );
- }
-
- reader.close();
- }
-}
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 4562697..a1dac85 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -19,8 +19,6 @@ Maven 2 Help Plugin
* {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
- * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project.
-
* {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
the groupId and artifactId or the plugin prefix of the plugin to be specified.
@@ -42,3 +40,4 @@ Maven 2 Help Plugin
* {{{examples/describe-configuration.html}Configuring Describe Mojo}}
+
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 7436c0d..8467f6e 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -25,19 +25,6 @@ Usage
mvn help:active-profiles -Doutput=/path/to/file
+-----+
-* The <<<help:dependencies>>> Mojo
-
- The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
- It will output the resolved tree of dependencies that the Maven build process actually uses.
-
- Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
-
- You can execute this mojo using the following command:
-
-+-----+
-mvn help:dependencies -Doutput=/path/to/file
-+-----+
-
* The <<<help:describe>>> Mojo
The <<<describe>>> mojo is used to discover information about Maven plugins. Given a plugin prefix or groupId, artifactId,
@@ -89,3 +76,4 @@ mvn help:effective-settings -Doutput=/path/to/file
+-----+
+
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 22/35: o Fix typos.
Posted by hb...@apache.org.
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 c0da4ddc390e2e4a1b4625a4ee602f700156d4d9
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Tue Jul 17 16:16:48 2007 +0000
o Fix typos.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@556956 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/index.apt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index a1dac85..b620f97 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -19,8 +19,8 @@ Maven 2 Help Plugin
* {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
- * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires
- the groupId and artifactId or the plugin prefix of the plugin to be specified.
+ * {{{describe-mojo.html}help:describe}} describes the attributes of a plugin and/or plugin mojo. For its execution, it requires
+ the groupId and artifactId or the prefix of the plugin to be specified.
* {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active
profiles factored in.
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.
[maven-help-plugin] 26/35: o Add xml declaration. o Add used but
undeclared dependencies. o Specify version for maven-changelog-plugin.
Posted by hb...@apache.org.
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 7510c3a3caf50bd1dfc87be240a4589cb2908fe2
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Sun Nov 11 22:18:36 2007 +0000
o Add xml declaration.
o Add used but undeclared dependencies.
o Specify version for maven-changelog-plugin.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-help-plugin@593975 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 24 ++++++++++++++++++++++--
1 file changed, 22 insertions(+), 2 deletions(-)
diff --git a/pom.xml b/pom.xml
index c490fd4..ef50a1c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,3 +1,4 @@
+<?xml version='1.0' encoding='UTF-8'?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -44,6 +45,11 @@ under the License.
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
+ <artifactId>maven-artifact</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>2.0</version>
</dependency>
@@ -59,6 +65,11 @@ under the License.
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
+ <artifactId>maven-model</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-tools-api</artifactId>
<version>2.0</version>
</dependency>
@@ -67,15 +78,24 @@ under the License.
<artifactId>maven-plugin-descriptor</artifactId>
<version>2.0</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-project</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-container-default</artifactId>
+ <version>1.0-alpha-9</version>
+ </dependency>
</dependencies>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changelog-plugin</artifactId>
+ <version>2.1</version>
</plugin>
</plugins>
</reporting>
</project>
-
-
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.