Author: khmarbaise
Date: Mon Jan 27 20:57:10 2014
New Revision: 1561846
URL: http://svn.apache.org/r1561846
Log:
[MENFORCER-182]
- Added documentation for WARN/ERROR
Patch applied by Mirko Friedenhagen
Modified:
maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/usage.apt.vm
Modified: maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/usage.apt.vm?rev=1561846&r1=1561845&r2=1561846&view=diff
==============================================================================
--- maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/usage.apt.vm
(original)
+++ maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/usage.apt.vm Mon
Jan 27 20:57:10 2014
@@ -54,6 +54,9 @@ Usage
[]
Each rule to be executed should be added to the rules element along with
the specific configuration for that rule.
+
+ As of version 2.0 you may add a <<<level>>> element to the standard rules.
Valid values are <<<WARN>>> and <<<ERROR>>>. When
+ <<<level>>> <<<WARN>>> is specified, the rule will only spit out a warning
but will not fail the build.
The <<<enforce>>> goal executes against each project in a multi-project
build. The <<<enforce-once>>> goal executes
just once per build. This is most effective for the standard rules because
the Maven, Java and OS versions will not change between projects in the same
build.
@@ -78,6 +81,14 @@ Usage
</goals>
<configuration>
<rules>
+ <bannedPlugins>
+ <!-- will only display a warning but does not fail the
build. -->
+ <level>WARN</level>
+ <excludes>
+
<exclude>org.apache.maven.plugins:maven-verifier-plugin</exclude>
+ </excludes>
+ <message>Please consider using the maven-invoker-plugin
(http://maven.apache.org/plugins/maven-invoker-plugin/)!</message>
+ </bannedPlugins>
<requireMavenVersion>
<version>2.0.6</version>
</requireMavenVersion>
