You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/10/30 11:21:19 UTC
svn commit: r1635453 - in
/maven/plugins/trunk/maven-toolchains-plugin/src/site/apt: index.apt.vm
toolchains/index.apt toolchains/jdk.apt.vm usage.apt
Author: hboutemy
Date: Thu Oct 30 10:21:19 2014
New Revision: 1635453
URL: http://svn.apache.org/r1635453
Log:
little doc improvement
Modified:
maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/index.apt
maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/jdk.apt.vm
maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/usage.apt
Modified: maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm?rev=1635453&r1=1635452&r2=1635453&view=diff
==============================================================================
--- maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm Thu Oct 30 10:21:19 2014
@@ -25,20 +25,20 @@
${project.name}
- The Toolchains Plugins allows to share configuration across plugins. For example to make sure the plugins like compiler, surefire, javadoc, webstart etc. all use the same JDK for execution.
+ The Toolchains Plugins allows to share configuration across plugins.
+ For example to make sure the plugins like compiler, surefire, javadoc, webstart etc. all use the same JDK for execution.
Similarly to maven-enforcer-plugin, it allows to control environmental constraints in the build.
* Goals Overview
The Toolchains plugin has one goal:
- *{{{./toolchain-mojo.html}toolchain:toolchain}} The goal is typically to be attached to the "validate" phase of default lifecycle.
+ * {{{./toolchain-mojo.html}toolchain:toolchain}} The goal is typically to be attached to the "validate" phase of default lifecycle.
* Usage
General instructions on how to use the Toolchains Plugin can be found on the {{{./usage.html}usage page}}.
- Last but not least, users occasionally contribute
- additional examples, tips or errata to the
+ Last but not least, users occasionally contribute additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Toolchains+Plugin}plugin's wiki page}}.
In case you still have questions regarding the plugin's usage, please feel
Modified: maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/index.apt?rev=1635453&r1=1635452&r2=1635453&view=diff
==============================================================================
--- maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/index.apt (original)
+++ maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/index.apt Thu Oct 30 10:21:19 2014
@@ -20,12 +20,12 @@
------
Milos Kleint
------
- Oct 2007
+ 2007-10-10
------
Standard Toolchains
- The following standard toolchains are included by default with Maven.
+ The following standard toolchains are included by default with Maven:
* {{{./jdk.html}JDK}} - Defines the Java Development Kit location and identification
Modified: maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/jdk.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/jdk.apt.vm?rev=1635453&r1=1635452&r2=1635453&view=diff
==============================================================================
--- maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/jdk.apt.vm (original)
+++ maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/toolchains/jdk.apt.vm Thu Oct 30 10:21:19 2014
@@ -20,88 +20,79 @@
------
Milos Kleint
------
- October 2007
+ 2007-10-01
------
Toolchain Identification
- The toolchain type id is "jdk".
+ The toolchain type id for JDK is "<<<jdk>>>".
Predefined identification tokens are:
- * "version" marks the version of the jdk. Plugin can match against a single version or any version ranges.
+ * "<<<version>>>" marks the version of the jdk. Maven Toolchains Plugin can match against a single version or any version ranges,
* any other tokens will be accepted, but only exact matches are supported.
Toolchain Configuration
- There is only one configuration element named "jdkHome". It designates the root directory
+ There is only one configuration element named "<<<jdkHome>>>". It designates the root directory
of JDK installation.
-Sample toolchains.xml Setup
+Sample <<<toolchains.xml>>> setup:
+---+
<toolchains>
- <toolchain>
- <type>jdk</type>
- <provides>
- <version>1.5</version>
- <vendor>sun</vendor>
- <id>for_mevenide</id>
- </provides>
- <configuration>
- <jdkHome>/home/mkleint/javatools/jdk</jdkHome>
- </configuration>
- </toolchain>
+ <toolchain>
+ <type>jdk</type>
+ <provides>
+ <version>1.5</version>
+ <vendor>sun</vendor>
+ <id>for_mevenide</id>
+ </provides>
+ <configuration>
+ <jdkHome>/home/mkleint/javatools/jdk</jdkHome>
+ </configuration>
+ </toolchain>
[...]
</toolchains>
+---+
-Plugin Configuration
+Toolchains Plugin Configuration
- For selection of toolchain for use by the project the following conditions are matched
-against the definitions in the toolchains.xml file.
+ For selection of toolchain for use by the project, the following conditions are matched
+against the definitions in the <<<toolchains.xml>>> file:
- * "version" which accepts any {{{http://maven.apache.org/plugins/maven-enforcer-plugin/rules/versionRanges.html}version range definitions}}.
- Version declared by the toolchain needs to fit into the range.
+ * "<<<version>>>" which accepts any {{{/plugins/maven-enforcer-plugin/rules/versionRanges.html}version range definitions}}.
+ Version declared by the toolchain needs to fit into the range,
* any other tokens needs exact match. Toolchain not providing such token will not be selected.
All conditions need to be satisfied in a sucessfully matched toolchain.
-Sample Plugin Configuration:
+Sample Plugin Configuration
+---+
<project>
[...]
<plugins>
<build>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-toolchains-plugin</artifactId>
- <version>${project.version}</version>
- <executions>
- <execution>
- <phase>validate</phase>
- <goals>
- <goal>toolchain</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <toolchains>
- <jdk>
- <version>[1.5,)</version>
- </jdk>
- </toolchains>
- </configuration>
- </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-toolchains-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <toolchains>
+ <jdk>
+ <version>[1.5,)</version>
+ </jdk>
+ </toolchains>
+ </configuration>
+ </plugin>
</plugins>
</build>
[...]
</project>
+---+
-
\ No newline at end of file
Modified: maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/usage.apt?rev=1635453&r1=1635452&r2=1635453&view=diff
==============================================================================
--- maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/usage.apt Thu Oct 30 10:21:19 2014
@@ -20,7 +20,7 @@
------
Milos Kleint
------
- Oct 2007
+ 2007-10-01
------
Usage
@@ -31,28 +31,28 @@ Usage
See the following links for information about including and configuring plugins in your project:
- *{{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html}Configuring Plugins}}
+ * {{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html}Configuring Plugins}}
- *{{{http://maven.apache.org/guides/plugin/guide-java-plugin-development.html}Plugin Development}}
+ * {{{http://maven.apache.org/guides/plugin/guide-java-plugin-development.html}Plugin Development}}
- *{{{http://maven.apache.org/guides/introduction/introduction-to-plugin-prefix-mapping.html}Plugin Prefix}}
+ * {{{http://maven.apache.org/guides/introduction/introduction-to-plugin-prefix-mapping.html}Plugin Prefix}}
[]
* What is a toolchain?
Toolchain is a preconfigured object that maven plugins can ask for tool location and other information.
-The toolchains-plugin can read the persisted toolchains on the user's computer
-and match it against the toolchain requirements of the project (as configured in pom.xml)
-If match is found, the toolchain instance is made available to other maven plugins.
-That way all plugins can use the same JDK instance for example without hardcoding absolute paths into the pom.xml
+The toolchains-plugin can read the persisted toolchains on the user's computer (as configured in <<<toolchains.xml>>>)
+and match it against the toolchain requirements of the project (as configured in <<<pom.xml>>>)
+If match is found, the toolchain instance is made available to other Maven plugins.
+That way, all plugins can use the same JDK instance for example without hardcoding absolute paths into the <<<pom.xml>>>
and without configuring all plugins that require path to JDK tools.
* The <<<toolchains:toolchain>>> mojo
- This goal are meant to be bound to a lifecycle phase and configured in your
- <<<pom.xml>>>. In order to function properly it shall be the first phase in the lifecycle, eg. the "validate" phase.
+ This goal is meant to be bound to a lifecycle phase and configured in your
+ <<<pom.xml>>>. In order to function properly, it shall be the first phase in the lifecycle, eg. the "<<<validate>>>" phase, which
+ is the default if you don't configure execution.
The available standard toolchains are described {{{./toolchains/index.html}here}}.
-