Author: sebb
Date: Fri Jan 16 11:15:07 2015
New Revision: 1652388
URL: http://svn.apache.org/r1652388
Log:
Document animal-sniffer profile
Modified:
commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
Modified: commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
URL:
http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml?rev=1652388&r1=1652387&r2=1652388&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml (original)
+++ commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml Fri Jan 16
11:15:07 2015
@@ -440,6 +440,20 @@
</p>
</subsection>
+ <subsection name="animal-sniffer profile (since CP37)">
+ <p>
+ This profile is enabled by default. It runs the Animal Sniffer plugin
on the main code during the "test" phase.
+ The main code base is checked against the API signature for the
compiler target version.
+ Restrictions: does not currently check test code; may not find all
invalid API usage.
+ The code still needs to be built and tested with the target compiler
version before a release.
+ However it should provide an early warning to developers using a more
recent version of Java.
+ </p>
+ <p>
+ The plugin can be temporarily disabled by using the command-line
option <code>-Danimal.sniffer.skip</code>.
+ It can be completely disabled for a component (not recommended) by
creating an empty file: <code>src/site/resources/profile.noanimal</code>
+ </p>
+ </subsection>
+
<subsection name="release profile">
<p>
<a
href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml";>commons-parent</a>
