Author: oching
Date: Mon Jul 10 00:17:33 2006
New Revision: 420452
URL: http://svn.apache.org/viewvc?rev=420452&view=rev
Log:
PR: MPH-17
Revised existing docs to conform with the standard documentation. Added
additional docs. Updated pom and site.xml. Also added javadocs.
Added:
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-help-plugin/src/site/fml/
maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml
Removed:
maven/plugins/trunk/maven-help-plugin/src/site/apt/active-profiles-mojo.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/describe-mojo.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/effective-pom-mojo.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/effective-settings-mojo.apt
Modified:
maven/plugins/trunk/maven-help-plugin/pom.xml
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
maven/plugins/trunk/maven-help-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-help-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/pom.xml?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-help-plugin/pom.xml Mon Jul 10 00:17:33 2006
@@ -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>
Modified:
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
Mon Jul 10 00:17:33 2006
@@ -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 @@
* 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 @@
*/
private File output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
@@ -80,6 +84,12 @@
}
}
+ /**
+ * 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 @@
}
}
+ /**
+ * 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 @@
message.append( "\n" );
}
+ /**
+ * Setter method for the list of projects.
+ *
+ * @param projects
+ */
public final void setProjects( List projects )
{
this.projects = projects;
Modified:
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
Mon Jul 10 00:17:33 2006
@@ -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 @@
*/
private boolean full;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException, MojoFailureException
{
@@ -225,6 +228,12 @@
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 @@
}
}
+ /**
+ * 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 @@
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 @@
}
}
+ /**
+ * 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 @@
}
}
+ /**
+ * 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 @@
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 @@
}
}
+ /**
+ * 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 @@
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 @@
}
}
+ /**
+ * 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 @@
}
}
+ /**
+ * 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 @@
}
}
+ /**
+ *
+ * @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 @@
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;
Modified:
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
Mon Jul 10 00:17:33 2006
@@ -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 @@
* 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 @@
*/
private File output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
@@ -122,6 +126,13 @@
}
}
+ /**
+ * 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
{
Modified:
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
Mon Jul 10 00:17:33 2006
@@ -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.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 @@
*/
private String output;
+ /**
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
public void execute()
throws MojoExecutionException
{
Added:
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt?rev=420452&view=auto
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
(added)
+++
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
Mon Jul 10 00:17:33 2006
@@ -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.
Added: maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt?rev=420452&view=auto
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt Mon Jul 10
00:17:33 2006
@@ -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}}
+
+
Added: maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt?rev=420452&view=auto
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (added)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt Mon Jul 10
00:17:33 2006
@@ -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
++-----+
+
+
Added: maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml?rev=420452&view=auto
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml Mon Jul 10
00:17:33 2006
@@ -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
Modified: maven/plugins/trunk/maven-help-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/site.xml?rev=420452&r1=420451&r2=420452&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/site.xml Mon Jul 10 00:17:33
2006
@@ -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>
