o Fix typos.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@670267 13f79535-47bb-0310-9956-ffa450edef68master
parent
e892353fd5
commit
a6b7edd342
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
Configuring Generation of Plugin Descriptor
|
Configuring Generation of Plugin Descriptor
|
||||||
|
|
||||||
To configure the generation of the plugin descriptor, add the following to the project's pom:
|
To configure the generation of the plugin descriptor, add the following to the project's POM:
|
||||||
|
|
||||||
+-----+
|
+-----+
|
||||||
<project>
|
<project>
|
||||||
|
|
@ -62,7 +62,7 @@ mvn archetype:create \
|
||||||
-DarchetypeArtifactId=maven-archetype-mojo
|
-DarchetypeArtifactId=maven-archetype-mojo
|
||||||
-----
|
-----
|
||||||
|
|
||||||
The generated plugin descriptor generated by <<<mvn package>>> should be:
|
The plugin descriptor generated by <<<mvn package>>> should be:
|
||||||
|
|
||||||
-----
|
-----
|
||||||
<plugin>
|
<plugin>
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
Configuring Generation of Help Mojo
|
Configuring Generation of Help Mojo
|
||||||
|
|
||||||
To configure the generation of an <<<Help>>> Mojo, add the following to the project's pom:
|
To configure the generation of a <<<Help>>> Mojo, add the following to the project's POM:
|
||||||
|
|
||||||
+-----+
|
+-----+
|
||||||
<project>
|
<project>
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
Configuring Generation of Documentation Reports
|
Configuring Generation of Documentation Reports
|
||||||
|
|
||||||
To configure the generation of the documentation reports, add the following to the project's pom:
|
To configure the generation of the documentation reports, add the following to the project's POM:
|
||||||
|
|
||||||
+-----+
|
+-----+
|
||||||
<project>
|
<project>
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ Maven Plugin Plugin
|
||||||
The Maven Plugin Plugin is used to create a Maven plugin descriptor for any
|
The Maven Plugin Plugin is used to create a Maven plugin descriptor for any
|
||||||
{{{http://maven.apache.org/general.html#What_is_a_Mojo}Mojo}}'s found in the source tree, to include in the JAR.
|
{{{http://maven.apache.org/general.html#What_is_a_Mojo}Mojo}}'s found in the source tree, to include in the JAR.
|
||||||
It is also used to generate report files for the Mojos as well as for updating the plugin registry, the artifact
|
It is also used to generate report files for the Mojos as well as for updating the plugin registry, the artifact
|
||||||
metadata and a generic help goal.
|
metadata and generating a generic help goal.
|
||||||
|
|
||||||
* Goals Overview
|
* Goals Overview
|
||||||
|
|
||||||
|
|
@ -47,7 +47,7 @@ Maven Plugin Plugin
|
||||||
metadata to the project's artifact, for subsequent installation and deployment. The first use-case for this
|
metadata to the project's artifact, for subsequent installation and deployment. The first use-case for this
|
||||||
is to add the LATEST metadata (which is plugin-specific) for shipping alongside the plugin's artifact.
|
is to add the LATEST metadata (which is plugin-specific) for shipping alongside the plugin's artifact.
|
||||||
|
|
||||||
* {{{helpmojo-mojo.html}plugin:helpmojo}} generates an help mojo which describes all project mojos.
|
* {{{helpmojo-mojo.html}plugin:helpmojo}} generates a help mojo which describes all project mojos.
|
||||||
|
|
||||||
[]
|
[]
|
||||||
|
|
||||||
|
|
@ -57,7 +57,7 @@ Maven Plugin Plugin
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
|
||||||
The following example shows how to use the Plugin Plugin in more advanced usecases:
|
The following examples shows how to use the Plugin Plugin in more advanced usecases:
|
||||||
|
|
||||||
* {{{examples/generate-descriptor.html}Configuring Generation of Plugin Descriptor}}
|
* {{{examples/generate-descriptor.html}Configuring Generation of Plugin Descriptor}}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,14 +27,14 @@
|
||||||
|
|
||||||
*Abstract
|
*Abstract
|
||||||
|
|
||||||
The Plugin plugin needs to be refactored in order to support multiple mojo
|
The Plugin Plugin needs to be refactored in order to support multiple mojo
|
||||||
implementation languages. This document will detail the steps needed to
|
implementation languages. This document will detail the steps needed to
|
||||||
add this functionality.
|
add this functionality.
|
||||||
|
|
||||||
*Current Status
|
*Current Status
|
||||||
|
|
||||||
The plugin plugin currently calls out to a set of generators in the
|
The Plugin Plugin currently calls out to a set of generators in the
|
||||||
maven-plugin-tools library, which in turn uses qdox to generate various things
|
maven-plugin-tools library, which in turn uses QDox to generate various things
|
||||||
based on annotations in the java source code.
|
based on annotations in the java source code.
|
||||||
|
|
||||||
*Refactored Design
|
*Refactored Design
|
||||||
|
|
@ -47,4 +47,4 @@
|
||||||
centrally aggregated by the generator-manager. After all generators have run,
|
centrally aggregated by the generator-manager. After all generators have run,
|
||||||
the generator-manager will call another class (depending on what it's meant to
|
the generator-manager will call another class (depending on what it's meant to
|
||||||
produce) to take all the aggregated mojo descriptors and produce a result
|
produce) to take all the aggregated mojo descriptors and produce a result
|
||||||
(such as plugin.xml file for the project).
|
(such as <<<plugin.xml>>> file for the project).
|
||||||
|
|
@ -26,8 +26,8 @@
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
|
|
||||||
The Plugin Plugin is generally used for Maven 2 plugins. Its mojos are bound to different phases in the build life cycle.
|
The Plugin Plugin is generally used for Maven 2 plugins. Its goals are bound to different phases in the build life cycle.
|
||||||
So when you execute a specific phase, the Plugin Plugin mojos bound to it are also executed. Aside from this, each goal can
|
So when you execute a specific phase, the Plugin Plugin goals bound to it are also executed. Aside from this, each goal can
|
||||||
also be explicitly executed from the command line.
|
also be explicitly executed from the command line.
|
||||||
|
|
||||||
* The <<<plugin:descriptor>>> Goal
|
* The <<<plugin:descriptor>>> Goal
|
||||||
|
|
@ -41,7 +41,7 @@ Usage
|
||||||
mvn package
|
mvn package
|
||||||
+-----+
|
+-----+
|
||||||
|
|
||||||
You will see that the plugin.xml file is generated in the <<<target/classes/META-INF/maven>>> directory of your project. The file is
|
You will see that the <<<plugin.xml>>> file is generated in the <<<target/classes/META-INF/maven>>> directory of your project. The file is
|
||||||
also bundled in the generated jar file.
|
also bundled in the generated jar file.
|
||||||
|
|
||||||
To explicitly execute the <<<plugin:descriptor>>> goal, type the following in the command line:
|
To explicitly execute the <<<plugin:descriptor>>> goal, type the following in the command line:
|
||||||
|
|
@ -71,7 +71,7 @@ mvn plugin:xdoc
|
||||||
mvn install
|
mvn install
|
||||||
+-----+
|
+-----+
|
||||||
|
|
||||||
you will see that the version of the plugin in the plugin-registry.xml is changed to the same version of the plugin
|
you will see that the version of the plugin in the <<<plugin-registry.xml>>> is changed to the same version of the plugin
|
||||||
that you have just installed.
|
that you have just installed.
|
||||||
|
|
||||||
You can also explicitly execute the <<<plugin:updateRegistry>>> goal by executing
|
You can also explicitly execute the <<<plugin:updateRegistry>>> goal by executing
|
||||||
|
|
@ -93,7 +93,7 @@ mvn package
|
||||||
|
|
||||||
* The <<<plugin:helpmojo>>> Goal
|
* The <<<plugin:helpmojo>>> Goal
|
||||||
|
|
||||||
To generate an <<<HelpMojo>>> for the mojos of your plugin, execute the following on the command line:
|
To generate a <<<HelpMojo>>> for the mojos of your plugin, execute the following on the command line:
|
||||||
|
|
||||||
+-----+
|
+-----+
|
||||||
mvn plugin:helpmojo
|
mvn plugin:helpmojo
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue