svn commit: r992590 - in /maven/plugins/trunk/maven-compiler-plugin/src/site/apt: examples/set-compiler-source-and-target.apt.vm index.apt

[be...@apache.org]

Author: bentmann
Date: Sat Sep  4 12:30:34 2010
New Revision: 992590

URL: http://svn.apache.org/viewvc?rev=992590&view=rev
Log:
o Polished docs

Modified:
    maven/plugins/trunk/maven-compiler-plugin/src/site/apt/examples/set-compiler-source-and-target.apt.vm
    maven/plugins/trunk/maven-compiler-plugin/src/site/apt/index.apt

Modified: maven/plugins/trunk/maven-compiler-plugin/src/site/apt/examples/set-compiler-source-and-target.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-compiler-plugin/src/site/apt/examples/set-compiler-source-and-target.apt.vm?rev=992590&r1=992589&r2=992590&view=diff
==============================================================================
--- maven/plugins/trunk/maven-compiler-plugin/src/site/apt/examples/set-compiler-source-and-target.apt.vm (original)
+++ maven/plugins/trunk/maven-compiler-plugin/src/site/apt/examples/set-compiler-source-and-target.apt.vm Sat Sep  4 12:30:34 2010
@@ -57,4 +57,11 @@ Setting the <<<-source>>> and <<<-target
   </build>
   [...]
 </project>
-+-----
\ No newline at end of file
++-----
+
+  <<Note:>> Merely setting the <<<target>>> option does not guarantee that your code actually runs on a JRE with the
+  specified version. The pitfall is unintended usage of APIs that only exist in later JREs which would make your code
+  fail at runtime with a linkage error. To avoid this issue, you can either configure the compiler's boot classpath
+  to match the target JRE or use the
+  {{{http://mojo.codehaus.org/animal-sniffer-maven-plugin/}Animal Sniffer Maven Plugin}} to verify your code doesn't
+  use unintended APIs.

Modified: maven/plugins/trunk/maven-compiler-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-compiler-plugin/src/site/apt/index.apt?rev=992590&r1=992589&r2=992590&view=diff
==============================================================================
--- maven/plugins/trunk/maven-compiler-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-compiler-plugin/src/site/apt/index.apt Sat Sep  4 12:30:34 2010
@@ -30,7 +30,7 @@ Maven Compiler Plugin
 
   The Compiler Plugin is used to compile the sources of your project.  The
   default compiler is <<<javac>>> and is used to compile Java sources.
-  The default <<<source>>> setting is <<<1.5>>> and the default <<<target>>>
+  Also note that at present the default <<<source>>> setting is <<<1.5>>> and the default <<<target>>>
   setting is <<<1.5>>>, independently of the JDK you run Maven with.
   If you want to change these defaults, you should set <<<source>>> and <<<target>>>
   as described in
@@ -41,8 +41,8 @@ Maven Compiler Plugin
 
   This Compiler Plugin is the Maven 2 version of Maven 1.x's Java Plugin.
 
-  <<NOTE:>> <To know more about the Java JDK 1.4 javac, please see:
-  {{http://java.sun.com/j2se/1.4.2/docs/tooldocs/tools.html#basic}}.>
+  <<NOTE:>> <To know more about the JDK javac, please see:
+  {{http://download.oracle.com/javase/6/docs/technotes/tools/windows/javac.html}}.>
 
 * Goals Overview