Author: dennisl
Date: Wed Jan 2 10:12:09 2008
New Revision: 608167
URL: http://svn.apache.org/viewvc?rev=608167&view=rev
Log:
[MPMD-39] Target JDK should default to configuration of the compiler plugin
o The issue has not and will not be fixed. Instead I have documented the best
practice for configuring this.
Added:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
(with props)
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt?rev=608167&view=auto
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
(added)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
Wed Jan 2 10:12:09 2008
@@ -0,0 +1,71 @@
+ ------
+ Target JDK
+ ------
+ Dennis Lundberg
+ ------
+ 2008-01-02
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Target JDK
+
+ There is a configuration element in the PMD plugin that let you set which
+ target JDK to use. Often you want this to be in sync with the configuration
+ for maven-compiler-plugin. The best practice for this is to set up a property
+ and use that in the configuration section for each of the plugins. Here is
+ an example on how to set that up:
+
++--------------------+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <configuration>
+ <source>${compileSource}</source>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <configuration>
+ <targetJdk>${compileSource}</targetJdk>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+ <properties>
+ <compileSource>1.5</compileSource>
+ </properties>
+ ...
+</project>
++--------------------+
+
+
+
+
Propchange:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
------------------------------------------------------------------------------
svn:keywords = Date Revision Author Id
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml?rev=608167&r1=608166&r2=608167&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml Wed Jan 2 10:12:09
2008
@@ -29,6 +29,7 @@
</menu>
<menu name="Examples">
<item name="Remove Report" href="examples/removeReport.html"/>
+ <item name="Target JDK" href="examples/targetJdk.html"/>
<item name="Using Rule Sets" href="examples/usingRuleSets.html"/>
<item name="Violation Checking" href="examples/violationChecking.html"/>
</menu>
