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
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>
17 changes: 9 additions & 8 deletions src/site/markdown/examples/describe-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,17 @@ You can use the `goal` parameter of the `describe` goal to show or display relat

For example, when you execute the following command:

```unknown
```sh
# mvn help:describe -Dgoal=describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-help-plugin
```

This would display brief information about the `describe` goal only.

## 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 goal, phase, or lifecycle:

```unknown
```sh
# mvn -help

usage: mvn [options] [<goal(s)>] [<phase(s)>]
Expand All @@ -85,7 +85,7 @@ usage: mvn [options] [<goal(s)>] [<phase(s)>]

The following are some examples:

```unknown
```sh
# mvn help:describe -Dcmd=clean
...
[INFO] [help:describe]
Expand Down Expand Up @@ -167,9 +167,10 @@ 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 descriptions:
If you don't provide a parameter, a list is added with the mojos of the plugin and their
descriptions:

```unknown
```sh
# mvn help:describe -Dplugin=help
...
[INFO] org.apache.maven.plugins:maven-help-plugin:2.1-SNAPSHOT
Expand Down Expand Up @@ -237,14 +238,14 @@ For more information, run 'mvn help:describe [...] -Ddetail'

The `detail` parameter also displays information about the goal's implementation, their parameters and component requirements, among others.

```unknown
```sh
# mvn help:describe -Dplugin=help -Ddetail=true
```

## The `output` Parameter

This `describe` goal can use the optional `output` parameter to redirect the output to a file. Here is an example of that:

```unknown
```sh
# mvn help:describe -Dplugin=help -Ddetail=true -Doutput=/path/to/file
```
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