Author: hboutemy
Date: Fri Oct 31 23:29:06 2014
New Revision: 1635882
URL: http://svn.apache.org/r1635882
Log:
improved documentation
Modified:
maven/plugins/trunk/maven-toolchains-plugin/src/site/apt/index.apt.vm
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=1635882&r1=1635881&r2=1635882&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 Fri
Oct 31 23:29:06 2014
@@ -33,7 +33,7 @@ Similarly to maven-enforcer-plugin, it a
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}} checks that toolchains
requirements are met by currently configured toolchains.
* Usage
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=1635882&r1=1635881&r2=1635882&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
Fri Oct 31 23:29:06 2014
@@ -27,7 +27,7 @@ Toolchain Identification
The toolchain type id for JDK is "<<<jdk>>>".
- Predefined identification tokens are:
+ Predefined identification tokens, for requirement matching, are:
* "<<<version>>>" marks the version of the jdk. Maven Toolchains Plugin
can match against a single version or any version ranges,
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=1635882&r1=1635881&r2=1635882&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 Fri Oct
31 23:29:06 2014
@@ -41,18 +41,19 @@ Usage
* 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
(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.
+ A Toolchain is a preconfigured object that Maven plugins can use for tool
configuration retrieval (location and other information).
+ The toolchains-plugin can read available toolchains on the user's computer
(as configured in <<<toolchains.xml>>>) and match them
+ 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.
+
+ With <<<jdk>>> toolchain, for example, instead of being stuck with the JDK
used to run Maven, all plugins can use the same other JDK
+ instance without hardcoding absolute paths into the <<<pom.xml>>> and
without configuring every plugin that require path to JDK tools.
* The <<<toolchains:toolchain>>> mojo
- 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.
+ 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 phase.
The available standard toolchains are described
{{{./toolchains/index.html}here}}.
