Author: vsiveton
Date: Thu Aug 28 05:08:21 2008
New Revision: 689793
URL: http://svn.apache.org/viewvc?rev=689793&view=rev
Log:
o Updated index page of plugin site
o improved documentation
o added a reporting profile
Modified:
maven/plugins/trunk/maven-help-plugin/pom.xml
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/faq.fml
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=689793&r1=689792&r2=689793&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-help-plugin/pom.xml Thu Aug 28 05:08:21 2008
@@ -140,15 +140,6 @@
<scope>test</scope>
</dependency>
</dependencies>
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-changelog-plugin</artifactId>
- <version>2.1</version>
- </plugin>
- </plugins>
- </reporting>
<build>
<pluginManagement>
@@ -162,6 +153,15 @@
</pluginManagement>
</build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>2.1</version>
+ </plugin>
+ </plugins>
+ </reporting>
+
<profiles>
<profile>
<id>run-its</id>
@@ -190,5 +190,63 @@
</plugins>
</build>
</profile>
+
+ <profile>
+ <id>reporting</id>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <version>2.0</version>
+ <configuration>
+ <!-- For JIRA-report -->
+ <columnNames>Type,Key,Summary,Assignee,Status,Resolution,Fix
Version</columnNames>
+ <onlyCurrentVersion>true</onlyCurrentVersion>
+ <resolutionIds>Closed</resolutionIds>
+ <sortColumnNames>Type,Key</sortColumnNames>
+ <maxEntries>100</maxEntries> <!-- MCHANGES-124 -->
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>jira-report</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ <version>2.1</version>
+ </plugin>
+ <!-- TODO: remove when maven-plugins parent pom 12 is released -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-plugin-plugin</artifactId>
+ <version>2.4.3</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.5</version>
+ <configuration>
+ <tagletArtifacts>
+ <tagletArtifact>
+ <groupId>org.apache.maven.plugin-tools</groupId>
+ <artifactId>maven-plugin-tools-javadoc</artifactId>
+ <version>2.4.3</version>
+ </tagletArtifact>
+ <tagletArtifact>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-javadoc</artifactId>
+ <version>1.0</version>
+ </tagletArtifact>
+ </tagletArtifacts>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ </profile>
</profiles>
</project>
Modified:
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt?rev=689793&r1=689792&r2=689793&view=diff
==============================================================================
---
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
(original)
+++
maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt
Thu Aug 28 05:08:21 2008
@@ -1,10 +1,11 @@
------
- Configuring Describe Mojo
+ Configuring Describe Goal
------
John Casey
Maria Odea Ching
+ Vincent Siveton
------
- 2006-07-10
+ 2008-08-28
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -27,65 +28,252 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Configuring Describe Mojo
+Configuring Describe Goal
- Below are other configuration examples for the <<<describe>>> mojo.
+ Below are other configuration examples for the
<<<{{{../describe-mojo.html}help:describe}}>>> goal.
* 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:
+ 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
+# 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
+# mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
+---+
+ Here is an example to describe the Help plugin:
+
++-----+
+# mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin
++-----+
+
+ <<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:
+---+
-mvn help:describe -Dplugin=help
+# 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 a particular mojo
- of the plugin you specified.
+ You can use the <<<mojo>>> parameter of the <<<describe>>> goal to show or
display relative informations about a
+ particular goal 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
+# mvn help:describe -Dmojo=describe -DgroupId=org.apache.maven.plugins
-DartifactId=maven-help-plugin
+-----+
- This would display brief information about the <<<describe>>> mojo only.
+ This would display brief information about the <<<describe>>> goal only.
-* The <<<medium>>> and <<<full>>> Parameters
+* The <<<cmd>>> Parameter
- If you want to display more detailed information, you can use the <<<medium>>>
- or <<<full>>> parameters.
+ You could also ask for a single Maven command, i.e. a goal or a phase or a
lifecycle. It is the command when you call
+ Maven, i.e.:
+
++-----+
+# mvn -help
+
+usage: mvn [options] [<goal(s)>] [<phase(s)>]
+...
++-----+
- The <<<medium>>> parameter adds a list with the mojos of the plugin and their
+ The following are some examples:
+
++-----+
+# mvn help:describe -Dcmd=clean
+...
+[INFO] [help:describe]
+[INFO] 'clean' is a lifecycle with the following phases:
+* pre-clean: NOT DEFINED
+* clean: org.apache.maven.plugins:maven-clean-plugin:clean
+* post-clean: NOT DEFINED
+...
++-----+
+
++-----+
+# mvn help:describe -Dcmd=compile
+...
+[INFO] [help:describe]
+[INFO] 'compile' is a phase corresponding to this plugin:
+org.apache.maven.plugins:maven-compiler-plugin:compile
+
+It is a part of the lifecycle for the POM packaging 'jar'. This lifecycle
includes the following phases:
+* validate: NOT DEFINED
+* initialize: NOT DEFINED
+* generate-sources: NOT DEFINED
+* process-sources: NOT DEFINED
+* generate-resources: NOT DEFINED
+* process-resources: org.apache.maven.plugins:maven-resources-plugin:resources
+* compile: org.apache.maven.plugins:maven-compiler-plugin:compile
+* process-classes: NOT DEFINED
+* generate-test-sources: NOT DEFINED
+* process-test-sources: NOT DEFINED
+* generate-test-resources: NOT DEFINED
+* process-test-resources:
org.apache.maven.plugins:maven-resources-plugin:testResources
+* test-compile: org.apache.maven.plugins:maven-compiler-plugin:testCompile
+* process-test-classes: NOT DEFINED
+* test: org.apache.maven.plugins:maven-surefire-plugin:test
+* package: org.apache.maven.plugins:maven-jar-plugin:jar
+* pre-integration-test: NOT DEFINED
+* integration-test: NOT DEFINED
+* post-integration-test: NOT DEFINED
+* verify: NOT DEFINED
+* install: org.apache.maven.plugins:maven-install-plugin:install
+* deploy: org.apache.maven.plugins:maven-deploy-plugin:deploy
+...
++-----+
+
++-----+
+# mvn help:describe -Dcmd=compiler:compile
+...
+[INFO] [help:describe]
+[INFO] 'compiler:compile' is a plugin.
+org.apache.maven.plugins:maven-compiler-plugin:2.0.2
+Group Id: org.apache.maven.plugins
+Artifact Id: maven-compiler-plugin
+Version: 2.0.2
+Goal Prefix: compiler
+Description: Maven Plugins
+
+This plugin has 2 goals:
+
+Goal: 'compile'
+ Full Goal Name: 'compiler:compile'
+ Description: Compiles application sources
+
+Goal: 'testCompile'
+ Full Goal Name: 'compiler:testCompile'
+ Description: Compiles application test sources
+
+For more information, run 'mvn help:describe [...] -Dfull'
+...
++-----+
+
+* The <<<minimal>>>, <<<medium>>> and <<<full>>> Parameters
+
+ If you want to display less or more detailed informations, you can use the
<<<minimal>>>, <<<medium>>> or <<<full>>>
+ parameters.
+
+ The <<<minimal>>> parameter adds a minimal list of informations:
+
++-----+
+# mvn help:describe -Dplugin=help -Dminimal=true
+...
+[INFO] [help:describe]
+[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT
+Group Id: org.apache.maven.plugins
+Artifact Id: maven-help-plugin
+Version: 2.1-SNAPSHOT
+Goal Prefix: help
+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.
+
+For more information, run 'mvn help:describe [...] -Dfull'
+...
++-----+
+
+ The <<<medium>>> parameter is the default since 2.1 and adds a list with the
mojos of the plugin and their
descriptions:
+-----+
-mvn help:describe -Dplugin=help -Dmedium=true
+# mvn help:describe -Dplugin=help
+...
+[INFO] [help:describe]
+[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT
+Group Id: org.apache.maven.plugins
+Artifact Id: maven-help-plugin
+Version: 2.1-SNAPSHOT
+Goal Prefix: help
+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.
+
+This plugin has 9 goals:
+
+Goal: 'effective-settings'
+ Full Goal Name: 'help:effective-settings'
+ Description: Displays the calculated settings as XML for this project,
+ given any profile enhancement and the inheritance of the global settings
+ into the user-level settings.
+
+Goal: 'expressions'
+ Full Goal Name: 'help:expressions'
+ Description: Displays the supported Plugin expressions used by Maven.
+
+Goal: 'help'
+ Full Goal Name: 'help:help'
+ Description: Display help information on maven-help-plugin.
+ Call
+ mvn help:help -Ddetail=true -Dgoal=<goal-name>
+ to display parameter details.
+
+Goal: 'system'
+ Full Goal Name: 'help:system'
+ Description: Displays a list of the platform details like system properties
+ and environment variables.
+
+Goal: 'active-profiles'
+ Full Goal Name: 'help:active-profiles'
+ Description: Displays a list of the profiles which are currently active for
+ this build.
+
+Goal: 'describe'
+ Full Goal Name: 'help:describe'
+ Description: Displays a list of the attributes for a Maven Plugin and/or
+ Mojo (Maven plain Old Java Object).
+
+Goal: 'effective-pom'
+ Full Goal Name: 'help:effective-pom'
+ Description: Displays the effective POM as an XML for this build, with the
+ active profiles factored in.
+
+Goal: 'evaluate'
+ Full Goal Name: 'help:evaluate'
+ Description: Evaluates Maven expressions from the user.
+
+Goal: 'all-profiles'
+ Full Goal Name: 'help:all-profiles'
+ Description: Displays a list of available profiles under the current
+ project.
+ Note: it will list all profiles for a project. If a profile comes up with a
+ status inactive then there might be a need to set profile activation
+ switches/property.
+
+For more information, run 'mvn help:describe [...] -Dfull'
+...
++-----+
+
+ The <<<full>>> parameter also displays information about the mojos's
implementation, their parameters and component
+ requirements, among others.
+
+-----+
+# mvn help:describe -Dplugin=help -Dfull=true
++-----+
+
+ <<Note>>: The <<<medium>>> parameter was added in version 2.0.2 and the
<<<minimal>>> parameter was added in version
+ 2.1 of this Help plugin.
- <<Note:>> The <<<medium>>> parameter was added in version 2.0.2 of this
plugin.
+* The <<<output>>> Parameter
- The <<<full>>> parameter also displays information about the mojos'
- implementation, their parameters and component requirements, among others.
+ This <<<describe>>> goal can use the optional <<<output>>> parameter to
+ redirect the output to a file. Here is an example of that:
+-----+
-mvn help:describe -Dplugin=help -Dfull=true
+# mvn help:describe -Dplugin=help -Dfull=true -Doutput=/path/to/file
+-----+
Modified: 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=689793&r1=689792&r2=689793&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt Thu Aug 28
05:08:21 2008
@@ -2,8 +2,9 @@
Introduction
------
Maria Odea Ching
+ Vincent Siveton
------
- 2008-01-01
+ 2008-08-28
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,26 +29,36 @@
Maven Help Plugin
- The Maven Help Plugin is used to get relative information about a project or
the system. 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.
+ The Maven 2 Help Plugin is used to get relative information about a project
or the system. 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:
+ The Help plugin has 8 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 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.
+ * {{{all-profiles-mojo.html}help:all-profiles}} lists the available profiles
under the current project.
- * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM
for the current build, with the active
- profiles factored in.
+ * {{{describe-mojo.html}help:describe}} describes the attributes of a Plugin
and/or a Mojo (Maven plain Old Java
+ Object).
- * {{{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.
+ * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM
as an XML for the current build, with
+ the active profiles factored in.
- * {{{system-mojo.html}help:system}} displays the platform details like
system properties and environment variables.
+ * {{{effective-settings-mojo.html}help:effective-settings}} displays the
calculated settings as an XML for the
+ project, given any profile enhancement and the inheritance of the global
settings into the user-level settings.
+
+ * {{{evaluate-mojo.html}help:evaluate}} evaluates Maven expressions given by
the user in an interactive mode.
+
+ * {{{expressions-mojo.html}help:expressions}} displays the supported Plugin
expressions used by Maven.
+
+ * {{{system-mojo.html}help:system}} displays a list of the platform details
like system properties and environment
+ variables.
+
+ []
* Usage
@@ -57,7 +68,7 @@
In case you still have questions regarding the plugin's usage, please have a
look at the {{{faq.html}FAQ}} and feel
free to contact the {{{mail-lists.html}user mailing list}}. The posts to the
mailing list are archived and could
already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
- the mail archive.
+ the {{{mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
{{{issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
@@ -72,4 +83,6 @@
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}}
+ * {{{examples/describe-configuration.html}Configuring Describe Goal}}
+
+ []
Modified: 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=689793&r1=689792&r2=689793&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt Thu Aug 28
05:08:21 2008
@@ -3,6 +3,7 @@
------
John Casey
Maria Odea Ching
+ Vincent Siveton
------
2008-08-27
------
@@ -29,161 +30,100 @@
Usage
- Below are the different goals and configurations of the Help plugin.
+ Below are the different goals and the minimalist configurations of the Help
plugin.
+* The <<<help:active-profiles>>> Goal
-* The <<<help:active-profiles>>> Mojo
+ The <<<{{{active-profiles-mojo.html}active-profiles}}>>> goal 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>>>).
- 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>>>).
-
- You can execute this mojo using the following command:
+ You can execute this goal using the following command:
+-----+
# mvn help:active-profiles
+-----+
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
-* The <<<help:describe>>> Mojo
+* The <<<help:all-profiles>>> Goal
- 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.
+ The <<<{{{all-profiles-mojo.html}all-profiles}}>>> goal is used to discover
all available profiles under the
+ current project.
- This mojo requires either the <<<groupId>>> and <<<artifactId>>> parameters
or the <<<plugin>>> parameter to be specified:
+ You can execute this goal using the following command:
+-----+
-# mvn help:describe -DgroupId=org.somewhere -DartifactId=some-plugin
-Dversion=0.0.0
-+-----+
-
- or
-
-+-----+
-# mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
-+-----+
-
- Here is an example with the <<<mojo>>> parameter specified:
-
-+-----+
-# mvn help:describe -Dplugin=org.apache.maven.plugins:maven-help-plugin
-Dmojo=describe
+# mvn help:all-profiles
+-----+
- <<Note:>> <<<version>>> is always optional here.
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
- You could also asking for a single Maven command, i.e. a goal, a phase or a
lifecycle:
+* The <<<help:describe>>> Goal
-+-----+
-# mvn help:describe -Dcmd=clean
-...
-[INFO] [help:describe]
-[INFO] 'clean' is a lifecycle with the following phases:
-* pre-clean: NOT DEFINED
-* clean: org.apache.maven.plugins:maven-clean-plugin:clean
-* post-clean: NOT DEFINED
-...
-+-----+
+ The <<<{{{describe-mojo.html}describe}}>>> goal 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.
-or
+ You can execute this goal using the following command:
+-----+
-# mvn help:describe -Dcmd=compile
-...
-[INFO] [help:describe]
-[INFO] 'compile' is a phase corresponding to this plugin:
-org.apache.maven.plugins:maven-compiler-plugin:compile
-
-It is a part of the lifecycle for the POM packaging 'jar'. This lifecycle
includes the following phases:
-* validate: NOT DEFINED
-* initialize: NOT DEFINED
-* generate-sources: NOT DEFINED
-* process-sources: NOT DEFINED
-* generate-resources: NOT DEFINED
-* process-resources: org.apache.maven.plugins:maven-resources-plugin:resources
-* compile: org.apache.maven.plugins:maven-compiler-plugin:compile
-* process-classes: NOT DEFINED
-* generate-test-sources: NOT DEFINED
-* process-test-sources: NOT DEFINED
-* generate-test-resources: NOT DEFINED
-* process-test-resources:
org.apache.maven.plugins:maven-resources-plugin:testResources
-* test-compile: org.apache.maven.plugins:maven-compiler-plugin:testCompile
-* process-test-classes: NOT DEFINED
-* test: org.apache.maven.plugins:maven-surefire-plugin:test
-* package: org.apache.maven.plugins:maven-jar-plugin:jar
-* pre-integration-test: NOT DEFINED
-* integration-test: NOT DEFINED
-* post-integration-test: NOT DEFINED
-* verify: NOT DEFINED
-* install: org.apache.maven.plugins:maven-install-plugin:install
-* deploy: org.apache.maven.plugins:maven-deploy-plugin:deploy
-...
+# mvn help:describe -DgroupId=org.somewhere -DartifactId=some-plugin
-Dversion=0.0.0
+-----+
-or
-
-+-----+
-# mvn help:describe -Dcmd=compiler:compile
-...
-[INFO] [help:describe]
-[INFO] 'compiler:compile' is a plugin.
-Plugin: 'org.apache.maven.plugins:maven-compiler-plugin:2.0.2'
------------------------------------------------
-Group Id: org.apache.maven.plugins
-Artifact Id: maven-compiler-plugin
-Version: 2.0.2
-Goal Prefix: compiler
-Description:
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
-Maven Plugins
-...
-+-----+
+ Refer to {{{./examples/describe-configuration.html}Configuring Describe
Goal}} for more informations about its
+ configuration.
-* The <<<help:effective-pom>>> Mojo
+* The <<<help:effective-pom>>> Goal
- 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.
+ The <<<{{{effective-pom-mojo.html}effective-pom}}>>> goal 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.
- The mojo can be executed using the following command:
+ You can execute this goal using the following command:
+-----+
# mvn help:effective-pom
+-----+
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
-* The <<<help:effective-settings>>> Mojo
+* The <<<help:effective-settings>>> Goal
- 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 <<<{{{effective-settings-mojo.html}effective-settings}}>>> goal 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:
+ You can execute this goal using the following command:
+-----+
# mvn help:effective-settings
+-----+
-* The <<<help:system>>> Mojo
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
- The <<<system>>> mojo is used to view the system informations like system
properties and environment variables.
+* The <<<help:system>>> Goal
- The mojo can be executed using the following command:
+ The <<<{{{system-mojo.html}system}}>>> goal is used to view the system
informations like system properties and
+ environment variables.
+
+ You can execute this goal using the following command:
+-----+
# mvn help:system
+-----+
-* 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:
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
-+-----+
-# mvn help:active-profiles -Doutput=/path/to/file
-+-----+
+* The <<<expressions>>> Goal
-* Display the Plugin expressions used by Maven
-
- All mojos could use some expressions given by Maven. To list them, just call:
+ When you develop a new Maven Plugin, you could need to use some expressions
given by Maven. To list them, just call
+ the {{{expressions-mojo.html}expressions}} goal:
+-----+
# mvn help:expressions
@@ -208,13 +148,12 @@
...
+-----+
-* Display all profiles used by Maven
+ <<Note>>: you could also use the <<<output>>> parameter to redirect output to
a file.
-+-----+
-# mvn help:all-profiles
-+-----+
+* The <<<help:evaluate>>> Goal
-* Evaluate some Maven expressions
+ You could use this interactive goal to evaluate some Maven expressions. To
do it, just call the
+ {{{evaluate-mojo.html}help:evaluate}} goal:
+-----+
# mvn help:evaluate -Dartifact=org.apache.maven.plugins:maven-help-plugin
@@ -230,3 +169,9 @@
null object or invalid expression
...
+-----+
+
+ The <<<artifact>>> parameter refers to ask expressions on the artifact POM.
If omitted, the evaluate goal uses the current
+ pom.
+
+ You could ask for all Maven expressions listed by <<<help:expressions>>>
goal, i.e. $\{project\}, $\{project.licenses\},
+ $\{settings\}, $\{settings.profiles\}.
Modified: 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=689793&r1=689792&r2=689793&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml Thu Aug 28
05:08:21 2008
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,20 +21,19 @@
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="Why aren't profiles from the parent pom included?">
- <question>Why aren't profiles from the parent pom included?</question>
+ <faq id="What is a Mojo">
+ <question>What is a Mojo</question>
<answer>
<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.
+ See the Maven FAQ: <a
href="http://maven.apache.org/general.html#What_is_a_Mojo";>What is a Mojo</a>.
</p>
</answer>
</faq>
- <faq id="What_is_a_Mojo">
- <question>What is a Mojo?</question>
+ <faq id="Why mvn help:active-profiles won't show the active profiles under
Maven 2.1">
+ <question>Why <code>mvn help:active-profiles</code> won't show the
active profiles under Maven 2.1?</question>
<answer>
<p>
- See the Maven FAQ: <a
href="http://maven.apache.org/general.html#What_is_a_Mojo";>What is a Mojo</a>.
+ See <a href="http://jira.codehaus.org/browse/MPH-38";>MPH-38</a> for
more info.
</p>
</answer>
</faq>
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=689793&r1=689792&r2=689793&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/site.xml Thu Aug 28 05:08:21
2008
@@ -26,9 +26,10 @@
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="FAQ" href="faq.html"/>
+ <item name="Release Notes" href="jira-report.html"/>
</menu>
<menu name="Examples">
- <item name="Configuring Describe Mojo"
href="/examples/describe-configuration.html"/>
+ <item name="Configuring Describe Goal"
href="/examples/describe-configuration.html"/>
</menu>
</body>
</project>
