Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/site/apt/examples/describe-configuration.apt
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ Configuring Describe Goal

* The <<<cmd>>> Parameter

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.:
You can also ask for a single Maven command, e.g. a goal, a phase, or a lifecycle:

+-----+
# mvn -help
Expand Down Expand Up @@ -173,7 +172,7 @@ For more information, run 'mvn help:describe [...] -Ddetail'
...
+-----+

If you don't provide a paremeter a list is added with the mojos of the plugin and their
If you don't provide a parameter, a list is added with the mojos of the plugin and their
descriptions:

+-----+
Expand Down
13 changes: 6 additions & 7 deletions src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,9 @@

${project.name}

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 goals 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 Help Plugin provides information about a project or the system. It can be used to
describe a particular plugin, including the plugin's goals with their parameters and component requirements,
the effective POM and effective settings of the current build, and the profiles applied to the current project.

* Goals Overview

Expand All @@ -42,13 +41,13 @@ ${project.name}

* {{{./all-profiles-mojo.html}help:all-profiles}} lists the available profiles under the current project.

* {{{./describe-mojo.html}help:describe}} describes the attributes of a Plugin and/or a Mojo (Maven plain Old Java
* {{{./describe-mojo.html}help:describe}} describes the attributes of a plugin and/or a Mojo (Maven plain Old Java
Object).

* {{{./effective-pom-mojo.html}help:effective-pom}} displays the effective POM as an XML for the current build, with
* {{{./effective-pom-mojo.html}help:effective-pom}} displays the effective POM as XML for the current build, with
the active profiles factored in. If <<<verbose>>>, a comment is added to each XML element describing the origin of the line.

* {{{./effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as an XML for the
* {{{./effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as 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.
Expand Down
20 changes: 10 additions & 10 deletions src/site/apt/usage.apt
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@

Usage

Below are the different goals and the minimalist configurations of the Help Plugin.
Below are the different goals and the minimal configuration of the Help Plugin.

* The <<<help:active-profiles>>> Goal

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>>>
The <<<{{{./active-profiles-mojo.html}active-profiles}}>>> goal lists the profiles that have been
applied to the projects currently being built. For each project in the build session, it outputs a list of
profiles that have been applied to that project, along with the source of the profile (POM, <<<settings.xml>>>
or <<<profiles.xml>>>).

You can execute this goal using the following command:
You can execute this goal with the following command:

+-----+
# mvn help:active-profiles
Expand Down Expand Up @@ -129,20 +129,20 @@ Usage
# mvn help:evaluate -Dartifact=org.apache.maven.plugins:maven-help-plugin
...
[INFO] [help:evaluate]
[INFO] Enter the Maven expression i.e. ${project.groupId} or 0 to exit?:
[INFO] Enter the Maven expression e.g. ${project.groupId} or 0 to exit?:
${project.artifactId}
[INFO]
maven-help-plugin
[INFO] Enter the Maven expression i.e. ${project.groupId} or 0 to exit?:
[INFO] Enter the Maven expression e.g. ${project.groupId} or 0 to exit?:
${project.none}
[INFO]
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.
The <<<artifact>>> parameter evaluates expressions on the specified artifact's POM. If omitted, the evaluate goal uses the current
project's POM.

You could ask for all Maven expressions listed in the Javadoc of the
You can ask for all Maven expressions listed in the Javadoc of the
{{{/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html}
<<<PluginParameterExpressionEvaluator>>>}} class.
12 changes: 2 additions & 10 deletions src/site/fml/faq.fml
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,9 @@ under the License.
<question>What is a Mojo</question>
<answer>
<p>
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="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 <a href="https://issues.apache.org/jira/browse/MPH-38">MPH-38</a> for more info.
See the Maven FAQ: <a href="https://maven.apache.org/general.html#What_is_a_Mojo">What is a Mojo</a>.
</p>
</answer>
</faq>
</part>
</faqs>
</faqs>
2 changes: 1 addition & 1 deletion src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ under the License.
<item name="Download" href="download.html"/>
</menu>
<menu name="Examples">
<item name="Configuring Describe Goal" href="/examples/describe-configuration.html"/>
<item name="Configuring Describe Goal" href="examples/describe-configuration.html"/>
</menu>
</body>
</site>
Loading