Prepare release pmd-eclipse-plugin 4.0.2.v20131031-1124

pmd-eclipse: update release procedure
pmd-eclipse: fix #1148 After changing exclude filters violations are not cleared
2013-10-31 12:35:23 +01:00 · 2013-10-31 12:30:13 +01:00 · 2013-10-31 12:08:27 +01:00 · 2013-10-30 21:02:51 +01:00 · 2013-10-30 21:01:26 +01:00 · 2013-10-29 22:27:33 +01:00
1198 changed files with 48161 additions and 42796 deletions
@@ -0,0 +1,27 @@
+[![PMD - Don't shoot the messenger][PMDLogo]][website]
+
+PMD
+===
+
+About
+-----
+PMD is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,
+unnecessary object creation, and so forth. It supports Java, JavaScript, XML, XSL.
+Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in
+Java, C, C++, C#, PHP, Ruby, Fortran, JavaScript.
+
+Source
+------
+Our latest source of PMD can be found on [GitHub]. Fork us!
+The current status of this repo can be seen at [BuildHive].
+
+News and Website
+----------------
+More information can be found on our [Website] and on [SourceForge].
+
+
+[PMDLogo]: http://pmd.sourceforge.net/pmd_logo.png
+[GitHub]: https://github.com/pmd/pmd
+[BuildHive]: https://buildhive.cloudbees.com/job/pmd/
+[Website]: http://pmd.sourceforge.net
+[SourceForge]: https://sourceforge.net/projects/pmd/
@@ -6,12 +6,13 @@
        <groupId>org.sonatype.oss</groupId>
        <artifactId>oss-parent</artifactId>
        <version>7</version>
+        <relativePath/>
  </parent>
  
  <groupId>net.sourceforge.pmd</groupId>
  <artifactId>pmd-build</artifactId>
  <name>PMD Build Plugin</name>
-  <version>0.7-SNAPSHOT</version>
+  <version>0.9-SNAPSHOT</version>
  <packaging>maven-plugin</packaging>
  <description>
    <![CDATA[
@@ -38,9 +39,10 @@ only if you modify the java code.
  </licenses>
  
  <scm>
-    <connection>scm:svn:https://pmd.svn.sourceforge.net/svnroot/pmd/trunk/maven-plugin-pmd-build</connection>
-    <developerConnection>scm:svn:https://pmd.svn.sourceforge.net/svnroot/pmd/trunk/maven-plugin-pmd-build</developerConnection>
-    <url>http://pmd.svn.sourceforge.net/viewvc/pmd/trunk/maven-plugin-pmd-build</url>
+    <connection>scm:git:git://github.com/pmd/pmd.git</connection>
+    <developerConnection>scm:git:ssh://git@github.com/pmd/pmd.git</developerConnection>
+    <url>https://github.com/pmd/pmd</url>
+    <tag>HEAD</tag>
  </scm>
  
  <developers>
@@ -73,13 +75,22 @@ only if you modify the java code.
       </plugin>
       
       <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-release-plugin</artifactId>
+          <version>2.3.2</version>
          <configuration>
-            <tagBase>https://pmd.svn.sourceforge.net/svnroot/pmd/tags/maven-plugin-pmd-build</tagBase>
+            <tagNameFormat>@{project.artifactId}/@{project.version}</tagNameFormat>
+            <pushChanges>false</pushChanges>
+            <localCheckout>true</localCheckout>
          </configuration>
       </plugin>
    </plugins>
  </build>
+
+  <properties>
+    <mavenVersion>3.0.3</mavenVersion>
+  </properties>
+
  <dependencies>
    <dependency>
      <groupId>org.apache.ant</groupId>
@@ -87,24 +98,48 @@ only if you modify the java code.
      <version>1.8.2</version>
      <scope>provided</scope>
    </dependency>
+
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-plugin-api</artifactId>
+      <version>${mavenVersion}</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-core</artifactId>
+      <version>${mavenVersion}</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-compat</artifactId>
+      <version>${mavenVersion}</version>
+      <scope>provided</scope>
+    </dependency>
+
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.8.2</version>
      <scope>test</scope>
    </dependency>
-    <dependency>
-      <groupId>org.apache.maven</groupId>
-      <artifactId>maven-plugin-api</artifactId>
-      <version>2.0</version>
-      <scope>provided</scope>
-    </dependency>
+
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.1</version>
        <scope>test</scope>
    </dependency>
+
+    <dependency>
+        <groupId>org.apache.maven.plugin-testing</groupId>
+        <artifactId>maven-plugin-testing-harness</artifactId>
+        <version>2.1</version>
+        <scope>test</scope>
+    </dependency>
  </dependencies>

  <reporting>
@@ -3,7 +3,6 @@ Release Howto for pmd-build:

 Prerequisites:
 --------------
-* You need to use SVN currently (git / git-svn is not supported at the moment)
 * You need to have a Jira account at Sonatype: https://issues.sonatype.org/
 * You need to have upload permissions to the staging repository for PMD at sonatype: https://issues.sonatype.org/browse/OSSRH-2295
 * For more infos: https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide
@@ -12,15 +11,16 @@ Prerequisites:
 * You need to have your settings.xml filled:
  -> configure the property gpg.keyname and any other property for the maven-gpg-plugin (e.g. via a profile)
  -> configure the server section (you need to configure your sonatype jira account for server id "sonatype-nexus-staging").
+* You'll need at least maven 3.0.4, see http://jira.codehaus.org/browse/MRELEASE-756

 Step by step:
 -------------
-1. Checkout trunk via svn:
+1. Checkout master branch:

-svn co https://pmd.svn.sourceforge.net/svnroot/pmd/trunk/maven-plugin-pmd-build
-cd maven-plugin-pmd-build
+git clone https://github.com/pmd/pmd.git
+cd pmd/maven-plugin-pmd-build
 
-2. Prepare the release (creates a new release tag in SVN).
+2. Prepare the release (creates a new release tag).
   This will be done for you: http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html
   Maven will ask you about the release version, the tag name and the new version. You can simply hit enter,
   to use the default values.
@@ -32,7 +32,6 @@ mvn release:prepare

 mvn release:perform

-
 4. Release it via Sonatype Nexus
 * Login to https://oss.sonatype.org/
 * Go to Staging Repositories page
@@ -41,5 +40,8 @@ mvn release:perform
 * Now you can download the artifacts again and verify they are working.
 * Once you are sure they are working, click "Release" and the artifacts are eventually available through maven central.

+5. Push your local changes if everything is fine

+git push origin master
+git push origin tag pmd-build/<version>

@@ -3,6 +3,8 @@
 */
 package net.sourceforge.pmd.ant;

+import java.net.URL;
+
 import net.sourceforge.pmd.build.PmdBuildException;
 import net.sourceforge.pmd.build.PmdBuildTools;
 import net.sourceforge.pmd.build.RuleSetToDocs;
@@ -20,7 +22,14 @@ public class PmdBuildTask extends Task {
    private String target;
    private String siteXml;
    private String siteXmlTarget;
+    private URL[] runtimeClasspath;

+    public URL[] getRuntimeClasspath() {
+	return runtimeClasspath;
+    }
+    public void setRuntimeClasspath(URL[] runtimeClasspath) {
+	this.runtimeClasspath = runtimeClasspath;
+    }
    public String getSiteXml() {
 		return siteXml;
 	}
@@ -72,6 +81,7 @@ public class PmdBuildTask extends Task {
 		tool.setSiteXml(siteXml);
 		tool.setSiteXmlTarget(this.siteXmlTarget);
 		tool.setRulesDirectory(this.rulesDirectory);
+		tool.setRuntimeClasspath(runtimeClasspath);
 	
 		try {
 	        	tool.convertRulesets();
@@ -90,6 +100,9 @@ public class PmdBuildTask extends Task {
 		    throw new BuildException("Attribute rulesDirectory is not optional");
 		if ( this.siteXml == null ||"".equals(siteXml))
 		    throw new BuildException("Attribute siteXml is not optional");
+		if ( this.runtimeClasspath == null || "".equals(runtimeClasspath)) {
+		    throw new BuildException("Attribute pmdClasspath is not optional");
+		}
 		// Optional Attributes
 		if ( this.mergedRulesetFilename != null && ! "".equals(this.mergedRulesetFilename) )
 			tool.setMergedRuleSetFilename(this.mergedRulesetFilename);
@@ -1,5 +1,7 @@
 package net.sourceforge.pmd.build;

+import java.net.URL;
+

 public interface PmdBuildTools {

@@ -42,4 +44,12 @@ public interface PmdBuildTools {
     * @param siteXmlTaget
     */
    public abstract void setSiteXmlTarget(String siteXmlTarget);
+
+    /**
+     * Configures the classpath to use to analyze the properties of rules.
+     * @param runtimeClasspath
+     * @see RuntimeRulePropertiesAnalyzer
+     */
+    public void setRuntimeClasspath(URL[] runtimeClasspath);
+
 }
@@ -7,6 +7,9 @@ import static net.sourceforge.pmd.build.util.ConfigUtil.getString;
 import static net.sourceforge.pmd.build.util.XmlUtil.createXmlBackbone;

 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.net.URL;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.logging.Logger;
@@ -19,6 +22,10 @@ import net.sourceforge.pmd.build.util.FileUtil;
 import net.sourceforge.pmd.build.util.XmlUtil;
 import net.sourceforge.pmd.build.xml.RulesetFileTemplater;

+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
 /**
 * A small class to convert files from pmd rulesets fmt to xdoc fmt
 *
@@ -36,6 +43,16 @@ public class RuleSetToDocs implements PmdBuildTools {
 	private String targetDirectory;
 	private String siteXml;
 	private String siteXmlTarget;
+	private URL[] runtimeClasspath;
+	private RuntimeRulePropertiesAnalyzer ruleAnalyzer;
+
+	public URL[] getRuntimeClasspath() {
+	    return runtimeClasspath;
+	}
+
+	public void setRuntimeClasspath(URL[] runtimeClasspath) {
+	    this.runtimeClasspath = runtimeClasspath;
+	}

 	public String getSiteXmlTarget() {
 		return siteXmlTarget;
@@ -104,6 +121,7 @@ public class RuleSetToDocs implements PmdBuildTools {
 	private void init() throws PmdBuildException {
 		FileUtil.createDirIfMissing(targetDirectory);
 		xmlFileTemplater = new RulesetFileTemplater(rulesDirectory);
+		ruleAnalyzer = new RuntimeRulePropertiesAnalyzer(runtimeClasspath);
 		logger.fine("Merge xsl:" + xmlFileTemplater.getMergeRulesetXsl());
 	}

@@ -145,7 +163,19 @@ public class RuleSetToDocs implements PmdBuildTools {
 	}

 	private void convertRuleSetFile(File ruleset,File target) throws PmdBuildException {
-		xmlFileTemplater.transform(ruleset,target,xmlFileTemplater.getRulesetToDocsXsl());
+	    try {
+		DOMSource dom = XmlUtil.createDomSourceFrom(new FileInputStream(ruleset));
+		Document document = (Document)dom.getNode();
+		NodeList rules = document.getElementsByTagName("rule");
+		for (int i = 0; i < rules.getLength(); i++) {
+		    Node rule = rules.item(i);
+		    ruleAnalyzer.analyze(document, rule);
+		}
+
+		xmlFileTemplater.transform(dom,target,xmlFileTemplater.getRulesetToDocsXsl());
+	    } catch (FileNotFoundException e) {
+		throw new IllegalArgumentException(e);
+	    }
 	}

 	private void addRulesetsToSiteXml(DOMSource backbone) {
@@ -0,0 +1,113 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+package net.sourceforge.pmd.build;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+public class RuntimeRulePropertiesAnalyzer {
+    private static final String XPATH_RULE_CLASSNAME = "net.sourceforge.pmd.lang.rule.XPathRule";
+    private ClassLoader cl;
+    private Class<?> propertySource;
+    private Class<?> propertyDesc;
+    private Method nameMethod;
+    private Method descMethod;
+    private Method defaultValueMethod;
+    private Field propertiesField;
+    private Field propertiesValues;
+
+    public RuntimeRulePropertiesAnalyzer(URL[] runtimeClasspath) {
+	init(runtimeClasspath);
+    }
+
+    private void init(URL[] runtimeClasspath) {
+	try {
+	    cl = new URLClassLoader(runtimeClasspath);
+	    propertySource = cl.loadClass("net.sourceforge.pmd.AbstractPropertySource");
+	    propertyDesc = cl.loadClass("net.sourceforge.pmd.PropertyDescriptor");
+	    nameMethod = propertyDesc.getDeclaredMethod("name");
+	    descMethod = propertyDesc.getDeclaredMethod("description");
+	    defaultValueMethod = propertyDesc.getDeclaredMethod("defaultValue");
+	    propertiesField = propertySource.getDeclaredField("propertyDescriptors");
+	    propertiesValues = propertySource.getDeclaredField("propertyValuesByDescriptor");
+	    propertiesField.setAccessible(true);
+	    propertiesValues.setAccessible(true);
+	} catch (Exception e) {
+	    throw new RuntimeException(e);
+	}
+    }
+
+    /**
+     * Analyzes the class of the given rule definition to find the properties
+     * this rule supports.
+     * The properties are directly added to the rule node.
+     * @param document the document, used to create new property nodes
+     * @param rule the rule to analyze
+     */
+    public void analyze(Document document, Node rule) {
+	Node classAttribute = rule.getAttributes().getNamedItem("class");
+	if (classAttribute == null) {
+	    // some rule definitions, like <rule ref="..."/> have no class attribute 
+	    return;
+	}
+	String classAtt = classAttribute.getTextContent();
+	if (XPATH_RULE_CLASSNAME.equals(classAtt)) {
+	    // xpath rules are ignored - they have there properties defined already in the rule definition xml
+	    return;
+	}
+
+	try {
+	    Class<?> clazz = cl.loadClass(classAtt);
+	    Object ruleInstance = clazz.newInstance();
+	    @SuppressWarnings("rawtypes")
+	    List properties = (List)propertiesField.get(ruleInstance);
+	    @SuppressWarnings("rawtypes")
+	    Map values = (Map)propertiesValues.get(ruleInstance);
+	    Element propsElem = null;
+	    NodeList ruleChilds = rule.getChildNodes();
+	    for (int j = 0; j < ruleChilds.getLength(); j++) {
+		Node item = ruleChilds.item(j);
+		if (item.getNodeType() == Node.ELEMENT_NODE && "properties".equals(item.getNodeName())) {
+		    propsElem = (Element)item;
+		    break;
+		}
+	    }
+	    if (propsElem == null) {
+		propsElem = document.createElement("properties");
+		rule.appendChild(propsElem);
+	    }
+
+	    for (Object o : properties) {
+		Object value = values.get(o);
+		if (value == null) {
+		    value = defaultValueMethod.invoke(o);
+		}
+
+		Element propElem = document.createElement("property");
+		propElem.setAttribute("name", (String)nameMethod.invoke(o));
+		propElem.setAttribute("description", (String)descMethod.invoke(o));
+		if (value != null) {
+		    String valueString = String.valueOf(value);
+		    if (value.getClass().isArray()) {
+		        valueString = Arrays.toString((Object[])value);
+		    }
+		    propElem.setAttribute("value", valueString);
+		}
+		propsElem.appendChild(propElem);
+	    }
+	} catch (Exception e) {
+	    throw new RuntimeException(e);
+	}
+    }
+}
@@ -5,6 +5,7 @@ package net.sourceforge.pmd.build.filefilter;

 import java.io.File;
 import java.io.FilenameFilter;
+import java.util.regex.Pattern;

 /**
 *
@@ -15,8 +16,13 @@ import java.io.FilenameFilter;
 public class RulesetFilenameFilter implements FilenameFilter {

 	// FUTURE: Make this somehow configurable ? Turn into an array passed by constructor ?
-	// TODO: move to compiled regex to improve perf.
-	private static final String[] patterns = { "^[0-9][0-9].*\\.xml", "^.*dogfood.*\\.xml", "^all-.*\\.xml", "^migrating_.*\\.xml", "^pmdspecific.xml"} ;
+	private static final Pattern EXCLUDE = Pattern.compile(
+		"(^[0-9][0-9].*\\.xml)" +
+		"|(^.*dogfood.*\\.xml)" +
+		"|(^all-.*\\.xml)" +
+		"|(^migrating_.*\\.xml)" +
+		"|(^pmdspecific.xml)"
+	);
 	
 	public boolean accept(File file, String name) {
 	    if ( doesNotMatchExcludeNames(name) ) 
@@ -26,10 +32,6 @@ public class RulesetFilenameFilter implements FilenameFilter {
 	}
 	
 	private boolean doesNotMatchExcludeNames(String name) {
-		for ( String pattern : patterns ) {
-			if ( name.matches(pattern))
-				return false;
-		}
-		return true;
+	    return !EXCLUDE.matcher(name).matches();
 	}
 }
@@ -15,8 +15,10 @@ import java.io.FilenameFilter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.util.HashSet;
-import java.util.Set;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedList;
+import java.util.List;

 import net.sourceforge.pmd.build.PmdBuildException;

@@ -28,20 +30,20 @@ public final class FileUtil {

 	public static String pathToParent = "..";

-	private FileUtil() {};
+	private FileUtil() {}

-	public static Set<File> listFilesFrom(File dir) {
+	public static List<File> listFilesFrom(File dir) {
 		return filterFilesFrom(dir, null);
 	}

-	public static Set<File> filterFilesFrom(File dir, FilenameFilter filter) {
-		Set<File> filteredFiles = new HashSet<File>(0);
+	public static List<File> filterFilesFrom(File dir, FilenameFilter filter) {
+		List<File> filteredFiles = new LinkedList<File>();
 		if ( dir != null ) {
 			File[] files = dir.listFiles(filter);
 			if ( files != null && files.length > 0 )
-				for ( int fileIterator = 0 ; fileIterator < files.length ; fileIterator++  )
-					filteredFiles.add(files[fileIterator]);
+			    filteredFiles.addAll(Arrays.asList(files));
 		}
+		Collections.sort(filteredFiles);
 		return filteredFiles;
 	}

@@ -1,15 +1,24 @@
 package net.sourceforge.pmd.maven;

+import java.io.File;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
 import net.sourceforge.pmd.build.PmdBuildException;
 import net.sourceforge.pmd.build.PmdBuildTools;
 import net.sourceforge.pmd.build.RuleSetToDocs;

+import org.apache.maven.artifact.Artifact;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.project.MavenProject;

 /**
 * Says "Hi" to the user.
 * @goal pmd-pre-site
+ * @requiresDependencyResolution runtime
 */
 public class PmdPreSite extends AbstractMojo
 {
@@ -37,28 +46,56 @@ public class PmdPreSite extends AbstractMojo
    /**
     * Path to the existing site descriptor
     *
-     * @parameter expression="${pmd.rulesets}" default-value="src/main/resources/rulesets/
+     * @parameter expression="${pmd.rulesets}" default-value="src/main/resources/rulesets/"
     */
-    private String rulesetsDirectory;    
+    private String rulesetsDirectory;
+
+    /**
+     * @parameter default-value="${project}"
+     * @required
+     * @readonly
+     */
+    private MavenProject project;
    
    public void execute() throws MojoExecutionException {
-        getLog().info("PMD: site generation preparation");
-        getLog().debug("- target:" + target);
-        getLog().debug("- siteXml:" + siteXml);
-        getLog().debug("- rulesets:" + rulesetsDirectory);
-        getLog().debug(" -siteXmlTarget" + siteXmlTarget);
-        PmdBuildTools tool = new RuleSetToDocs();
-		tool.setTargetDirectory(target);
-		tool.setSiteXml(siteXml);
-		tool.setRulesDirectory(rulesetsDirectory);
-		tool.setSiteXmlTarget(siteXmlTarget);
+	List<URL> runtimeClasspath = determineRuntimeClasspath();
+
+	getLog().info("PMD: site generation preparation");
+	getLog().debug("- target:" + target);
+	getLog().debug("- siteXml:" + siteXml);
+	getLog().debug("- rulesets:" + rulesetsDirectory);
+	getLog().debug(" -siteXmlTarget" + siteXmlTarget);
 	
-		try {
-	        	tool.convertRulesets();
-	        	tool.preSiteGeneration();
-		}
-		catch ( PmdBuildException e) {
-		    throw new MojoExecutionException(e.getMessage());
+	PmdBuildTools tool = new RuleSetToDocs();
+	tool.setTargetDirectory(target);
+	tool.setSiteXml(siteXml);
+	tool.setRulesDirectory(rulesetsDirectory);
+	tool.setSiteXmlTarget(siteXmlTarget);
+	tool.setRuntimeClasspath(runtimeClasspath.toArray(new URL[runtimeClasspath.size()]));
+
+	try {
+	    tool.convertRulesets();
+	    tool.preSiteGeneration();
+	}
+	catch ( PmdBuildException e) {
+	    throw new MojoExecutionException(e.getMessage());
+	}
+    }
+
+    private List<URL> determineRuntimeClasspath() {
+	List<URL> runtimeClasspath;
+	try {
+	    runtimeClasspath = new ArrayList<URL>();
+	    runtimeClasspath.add(new File(project.getBuild().getOutputDirectory()).toURI().toURL());
+	    Set<Artifact> runtimeArtifacts = project.getArtifacts();
+	    for (Artifact a : runtimeArtifacts) {
+		if (Artifact.SCOPE_COMPILE.equals(a.getScope()) || Artifact.SCOPE_RUNTIME.equals(a.getScope()) ) {
+		    runtimeClasspath.add(a.getFile().toURI().toURL());
 		}
+	    }
+	} catch (Exception e) {
+	    throw new RuntimeException(e);
+	}
+	return runtimeClasspath;
    }
 }
@@ -1,8 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+  BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ -->
 <xsl:stylesheet
    version="1.0"
    xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

+    <xsl:output method="xml" encoding="UTF-8" indent="yes"/>
+
    <xsl:template match="root">
 		<xsl:comment>
        THIS FILE HAS BEEN AUTOMATICLY GENERATED.
@@ -33,7 +33,7 @@
 		</document>
 	</xsl:template>

-	<xsl:template match="rule">
+	<xsl:template match="rule[@name]">
 		<xsl:variable name="rulename" select="@name"/>
 		<xsl:variable name="classname" select="@class"/>

@@ -55,7 +55,7 @@
 							<xsl:with-param name="classname" select="$classname"/>
 						</xsl:call-template>
 					</xsl:variable>
-					<p><xsl:value-of select="$definedByJavaClass"/>:<a><xsl:attribute name="href"><xsl:value-of select="concat(concat('../../xref/',$classfile),'.html')"/></xsl:attribute><xsl:value-of select="@class"/></a>
+					<p><xsl:value-of select="$definedByJavaClass"/>: <a><xsl:attribute name="href"><xsl:value-of select="concat(concat('../../xref/',$classfile),'.html')"/></xsl:attribute><xsl:value-of select="@class"/></a>
 	    		    </p>
 				</xsl:otherwise>
 			</xsl:choose>
@@ -29,6 +29,9 @@
              </li>
            </xsl:for-each>
          </ul>
+
+          <xsl:variable name="urlPrefixLength"><xsl:value-of select="string-length('${pmd.website.baseurl}/rules/')"/></xsl:variable>
+
          <xsl:for-each select="language">
            <xsl:variable name="language"><xsl:value-of select="@name"/></xsl:variable>
            <xsl:for-each select="ruleset">
@@ -40,8 +43,12 @@
              <subsection>
                <xsl:attribute name="name"><xsl:value-of select="@name"/> (<xsl:value-of select="$language"/>)</xsl:attribute>
                <ul>
-                  <xsl:for-each select="./rule">
-                    <li> <xsl:value-of select="@name"/>: <xsl:value-of select="description"/></li>
+                  <xsl:for-each select="./rule[@name]">
+                    <li>
+                      <a>
+                        <xsl:attribute name="href"><xsl:value-of select="substring(@externalInfoUrl,$urlPrefixLength + 1)"/></xsl:attribute>
+                        <xsl:value-of select="@name"/>
+                      </a>: <xsl:value-of select="description"/></li>
                  </xsl:for-each>
                </ul>
              </subsection>
@@ -0,0 +1,41 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+package net.sourceforge.pmd;
+
+/*
+ * Note: This class is here in pmd-build to test the RuntimeRulePropertiesAnalyzer
+ */
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class AbstractPropertySource {
+
+    protected List<PropertyDescriptor> propertyDescriptors = new ArrayList<PropertyDescriptor>();
+    protected Map<PropertyDescriptor, Object> propertyValuesByDescriptor = new HashMap<PropertyDescriptor, Object>();
+    
+    protected void defineProperty(final String name, final String description, final Object defaultValue) {
+	net.sourceforge.pmd.PropertyDescriptor descriptor = new net.sourceforge.pmd.PropertyDescriptor() {
+	    
+	    @Override
+	    public String name() {
+		return name;
+	    }
+	    
+	    @Override
+	    public String description() {
+		return description;
+	    }
+
+	    @Override
+	    public Object defaultValue() {
+	        return defaultValue;
+	    }
+	};
+	propertyDescriptors.add(descriptor);
+	propertyValuesByDescriptor.put(descriptor, defaultValue);
+    }
+}
@@ -0,0 +1,15 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+package net.sourceforge.pmd;
+
+/*
+ * Note: This class is here in pmd-build to test the RuntimeRulePropertiesAnalyzer
+ */
+
+public interface PropertyDescriptor {
+
+    String name();
+    String description();
+    Object defaultValue();
+}
@@ -5,10 +5,7 @@ package net.sourceforge.pmd;

 import java.io.File;

-import net.sourceforge.pmd.build.PmdBuildException;
-
-import org.apache.commons.io.FileUtils;
-import org.junit.After;
+import org.codehaus.plexus.util.FileUtils;
 import org.junit.Before;

 /**
@@ -19,31 +16,14 @@ import org.junit.Before;
 public abstract class TestBase {

    protected static String TEST_DIR = "target/test-environment/";
-    protected static File testDir = null;
+    protected static File testDir = new File(TEST_DIR);

    /**
     * @throws java.lang.Exception
     */
    @Before
    public void setUp() throws Exception {
-	testDir = new File(TEST_DIR);
-	if (! testDir.exists() && ! testDir.mkdir() )
-	{
-	    throw new PmdBuildException("Can't create " + TEST_DIR);
-	}
-	else if ( ! testDir.isDirectory() )
-	{
-	    throw new PmdBuildException("testdir " + TEST_DIR + " exist !");
-	}
-	
-	FileUtils.copyDirectory(new File("src/test/resources/sample-pmd"), testDir);
-    }
-    
-    @After
-    public void tearDown() throws Exception {
-	if (testDir != null) {
-	    FileUtils.deleteDirectory(testDir);
-	}
-	testDir = null;
+	FileUtils.deleteDirectory(testDir);
+	FileUtils.copyDirectoryStructure(new File("src/test/resources/sample-pmd"), testDir);
    }
 }
@@ -4,8 +4,14 @@

 package net.sourceforge.pmd.ant;

+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.net.URL;
+
 import net.sourceforge.pmd.TestBase;

+import org.apache.commons.io.IOUtils;
 import org.junit.Test;

 /**
@@ -17,10 +23,16 @@ public class PmdBuildTaskTest extends TestBase {
    @Test
    public void antTask() throws Exception {
 	PmdBuildTask task = new PmdBuildTask();
-	task.setRulesDirectory(TEST_DIR + "rulesets");
+	task.setRulesDirectory(TEST_DIR + "src/main/resources/rulesets");
 	task.setTarget(TEST_DIR + "target");
-	task.setSiteXml(TEST_DIR + "site/site.pre.xml");
-	task.setSiteXmlTarget(TEST_DIR + "site/site.xml");
+	task.setSiteXml(TEST_DIR + "src/site/site.pre.xml");
+	task.setSiteXmlTarget(TEST_DIR + "src/site/site.xml");
+	task.setRuntimeClasspath(new URL[] {new File("target/test-classes").toURI().toURL()});
 	task.execute();
+
+	String site = IOUtils.toString(new File(TEST_DIR + "src/site/site.xml").toURI());
+	assertTrue(site.contains("<item name=\"Basic\""));
+	assertTrue(site.contains("<item name=\"Code Size\""));
+	assertTrue(site.indexOf("<item name=\"Basic\"") < site.indexOf("<item name=\"Code Size\""));
    }
 }
@@ -3,8 +3,19 @@
 */
 package net.sourceforge.pmd.build;

+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.net.URL;
+import java.util.List;
+import java.util.Map;
+
 import net.sourceforge.pmd.TestBase;

+import org.apache.commons.io.IOUtils;
 import org.junit.Test;

 /**
@@ -16,9 +27,36 @@ public class RuleSetToDocsTest extends TestBase {
    @Test
    public void convertRulesetsTest() throws Exception {
 	RuleSetToDocs builder = new RuleSetToDocs();
-	builder.setRulesDirectory(TEST_DIR + "rulesets");
+	builder.setRulesDirectory(TEST_DIR + "src/main/resources/rulesets");
 	builder.setTargetDirectory(TEST_DIR + "target");
+	builder.setRuntimeClasspath(new URL[] {new File("target/test-classes").toURI().toURL()});

 	builder.convertRulesets();
+
+	String codeSizeRuleset = IOUtils.toString(new File(TEST_DIR + "target/java/codesize.xml").toURI());
+	assertTrue(codeSizeRuleset.contains("minimum"));
+    }
+
+    @Test
+    public void readPropertyDescriptors() throws Exception {
+	ClassLoader cl = RuleSetToDocsTest.class.getClassLoader();
+	Class<?> clazz = cl.loadClass("net.sourceforge.pmd.lang.java.rule.codesize.NPathComplexityRule");
+	Object ruleInstance = clazz.newInstance();
+	Class<?> propertySource = cl.loadClass("net.sourceforge.pmd.AbstractPropertySource");
+	Class<?> propertyDesc = cl.loadClass("net.sourceforge.pmd.PropertyDescriptor");
+	Method nameMethod = propertyDesc.getDeclaredMethod("name");
+	Method descMethod = propertyDesc.getDeclaredMethod("description");
+	Field propertiesField = propertySource.getDeclaredField("propertyDescriptors");
+	Field propertiesValues = propertySource.getDeclaredField("propertyValuesByDescriptor");
+	propertiesField.setAccessible(true);
+	propertiesValues.setAccessible(true);
+	@SuppressWarnings("rawtypes")
+	List properties = (List)propertiesField.get(ruleInstance);
+	@SuppressWarnings("rawtypes")
+	Map values = (Map)propertiesValues.get(ruleInstance);
+	assertEquals(1, properties.size());
+	assertEquals("minimum", nameMethod.invoke(properties.get(0)));
+	assertEquals("The minimum threshold property.", descMethod.invoke(properties.get(0)));
+	assertEquals("200.0", String.valueOf(values.get(properties.get(0))));
    }
 }
@@ -0,0 +1,29 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+package net.sourceforge.pmd.build;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+
+import net.sourceforge.pmd.build.filefilter.RulesetFilenameFilter;
+
+import org.junit.Test;
+
+public class RulesetFilenameFilterTest {
+
+    @Test
+    public void testAccept() {
+	RulesetFilenameFilter filter = new RulesetFilenameFilter();
+	File directory = new File(".");
+
+	assertTrue(filter.accept(directory, "codesize.xml"));
+	
+	assertFalse(filter.accept(directory, "some-text-file.txt"));
+	assertFalse(filter.accept(directory, "all-java.xml"));
+	assertFalse(filter.accept(directory, "dogfood.xml"));
+    }
+
+}
@@ -0,0 +1,17 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+package net.sourceforge.pmd.lang.java.rule.codesize;
+
+/*
+ * Note: This class is here in pmd-build to test the RuntimeRulePropertiesAnalyzer
+ */
+
+import net.sourceforge.pmd.AbstractPropertySource;
+
+public class NPathComplexityRule extends AbstractPropertySource {
+
+    public NPathComplexityRule() {
+	defineProperty("minimum", "The minimum threshold property.", 200.0d);
+    }
+}
@@ -0,0 +1,51 @@
+package net.sourceforge.pmd.maven;
+
+import java.io.File;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.maven.plugin.testing.AbstractMojoTestCase;
+import org.codehaus.plexus.util.FileUtils;
+import org.codehaus.plexus.util.StringUtils;
+import org.junit.Before;
+import org.junit.Test;
+
+public class PmdPreSiteTest extends AbstractMojoTestCase {
+
+    @Before
+    @Override
+    public void setUp() throws Exception {
+	super.setUp();
+	FileUtils.deleteDirectory( new File( getBasedir(), "target/unit/sample-pmd" ) );
+    }
+
+    @Test
+    public void testMojo() throws Exception {
+	FileUtils.copyDirectoryStructure(new File("src/test/resources/sample-pmd"),
+		new File("target/unit/sample-pmd"));
+
+	File pom = getTestFile( "target/unit/sample-pmd/pom.xml" );
+	assertNotNull( pom );
+	assertTrue( pom.exists() );
+
+	PmdPreSite myMojo = (PmdPreSite) lookupMojo( "pmd-pre-site", pom );
+	assertNotNull( myMojo );
+	myMojo.execute();
+
+
+	String codeSizeRuleset = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/java/codesize.xml").toURI());
+	assertTrue(codeSizeRuleset.contains("minimum"));
+
+	String basicRuleset = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/java/basic.xml").toURI());
+	assertEquals(1, StringUtils.countMatches(basicRuleset, "<subsection"));
+
+	String indexPage = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/index.xml").toURI());
+	assertFalse(indexPage.contains("<li>: </li>"));
+
+	String site = IOUtils.toString(new File("target/unit/sample-pmd/src/site/site.xml").toURI());
+	assertTrue(site.contains("<item name=\"Basic\""));
+	assertTrue(site.contains("<item name=\"Code Size\""));
+	assertTrue(site.indexOf("<item name=\"Basic\"") < site.indexOf("<item name=\"Code Size\""));
+    }
+
+
+}
@@ -0,0 +1,67 @@
+package net.sourceforge.pmd.maven.stubs;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.model.Build;
+import org.apache.maven.model.Model;
+import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
+import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
+import org.codehaus.plexus.util.ReaderFactory;
+
+public class ProjectStub extends MavenProjectStub {
+    /**
+     * Default constructor
+     */
+    public ProjectStub()
+    {
+        MavenXpp3Reader pomReader = new MavenXpp3Reader();
+        Model model;
+        try
+        {
+            model = pomReader.read( ReaderFactory.newXmlReader( new File( getBasedir(), "pom.xml" ) ) );
+            setModel( model );
+        }
+        catch ( Exception e )
+        {
+            throw new RuntimeException( e );
+        }
+
+        setGroupId( model.getGroupId() );
+        setArtifactId( model.getArtifactId() );
+        setVersion( model.getVersion() );
+        setName( model.getName() );
+        setUrl( model.getUrl() );
+        setPackaging( model.getPackaging() );
+
+        Build build = new Build();
+        build.setFinalName( model.getArtifactId() );
+        build.setDirectory( getBasedir() + "/target" );
+        build.setSourceDirectory( getBasedir() + "/src/main/java" );
+        build.setOutputDirectory( getBasedir() + "/target/classes" );
+        build.setTestSourceDirectory( getBasedir() + "/src/test/java" );
+        build.setTestOutputDirectory( getBasedir() + "/target/test-classes" );
+        setBuild( build );
+
+        List<String> compileSourceRoots = new ArrayList<String>();
+        compileSourceRoots.add( getBasedir() + "/src/main/java" );
+        setCompileSourceRoots( compileSourceRoots );
+
+        List<String> testCompileSourceRoots = new ArrayList<String>();
+        testCompileSourceRoots.add( getBasedir() + "/src/test/java" );
+        setTestCompileSourceRoots( testCompileSourceRoots );
+    }
+
+    /** {@inheritDoc} */
+    public File getBasedir()
+    {
+        return new File( super.getBasedir() + "/target/unit/sample-pmd/" );
+    }
+    
+    @Override
+    public List<Artifact> getRuntimeArtifacts() {
+	return new ArrayList<Artifact>();
+    }
+}
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>net.sourceforge.pmd</groupId>
+    <artifactId>pmd</artifactId>
+    <name>PMD</name>
+    <version>5.1.0-SNAPSHOT</version>
+
+    <build>
+        <plugins>
+            <plugin>
+              <groupId>net.sourceforge.pmd</groupId>
+              <artifactId>pmd-build</artifactId>
+              <version>0.7-SNAPSHOT</version>
+              <configuration>
+                <siteXml>${basedir}/target/unit/sample-pmd/src/site/site.pre.xml</siteXml>
+                <siteXmlTarget>${basedir}/target/unit/sample-pmd/src/site/site.xml</siteXmlTarget>
+                <target>${basedir}/target/unit/sample-pmd/target/generated-xdocs/rules</target>
+                <rulesetsDirectory>${basedir}/target/unit/sample-pmd/src/main/resources/rulesets/</rulesetsDirectory>
+              
+                <!-- The defined stubs -->
+                <project implementation="net.sourceforge.pmd.maven.stubs.ProjectStub"/>
+              </configuration>
+              <executions>
+                <execution>
+                <phase>pre-site</phase>
+                <goals>
+                  <goal>pmd-pre-site</goal>
+                </goals>
+                </execution>
+              </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+    </dependencies>
+</project>
@@ -47,4 +47,6 @@ public class JumbledIncrementerRule1 {
 ]]>
     </example>
     </rule>
+
+     <rule deprecated="true" ref="rulesets/java/codesize.xml/NPathComplexity"/>
 </ruleset>
@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+
+<ruleset name="Code Size"
+    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+
+  <description>
+The Code Size ruleset contains rules that find problems related to code size or complexity.
+  </description>
+
+<rule name="NPathComplexity"
+      since="3.9"
+      message="The method {0}() has an NPath complexity of {1}"
+      class="net.sourceforge.pmd.lang.java.rule.codesize.NPathComplexityRule"
+      externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#NPathComplexity">
+   <description>
+The NPath complexity of a method is the number of acyclic execution paths through that method.
+A threshold of 200 is generally considered the point where measures should be taken to reduce 
+complexity and increase readability.
+   </description>
+     <priority>3</priority>
+    <example>
+ <![CDATA[
+void bar() {	// this is something more complex than it needs to be,
+	if (y) {	// it should be broken down into smaller methods or functions
+		for (j = 0; j < m; j++) {
+			if (j > r) {
+				doSomething();
+				while (f < 5 ) {
+					anotherThing();
+					f -= 27;
+					}
+				} else {
+					tryThis();
+				}
+			}
+		}
+		if ( r - n > 45) {
+		   while (doMagic()) {
+		      findRabbits();
+		   }
+		}
+		try {
+			doSomethingDangerous();
+		} catch (Exception ex) {
+			makeAmends();
+			} finally {
+				dontDoItAgain();
+				}
+	}
+}
+
+ ]]>
+    </example>
+</rule>
+
+</ruleset>
@@ -0,0 +1,5 @@
+10-08-2012:
+  - Fix build: Update MANIFEST.MF Bundle-Version, add js-cvs-12122009.jar, use JDK 1.6 instead of 1.5. Also changed eclipse/plugins/org.eclipse.pde.build_3.8.0.v20110728/scripts/build.xml to set the builderDirectory using pathconvert. This is almost certainly the Wrong Way but has the advantage of working.
+  - Convert all tests from JUnit 3.x to 4.x.
+  - Make some failing tests pass.
+
@@ -1,34 +0,0 @@
-
-Compilation
-===========
-
-'ant plugin' will generate a new version in the 'build' directory.
-
-
-Setup
-=====
-
-If the default configuration is not accurate for your setup, customization
-can be done in local.properties to point to the Eclipse installation directory
-and the pde and launcher versions:
-
----- local.properties example -----------------
-eclipse.home=/usr/java/eclipse
-eclipse.pde.version=3.4.0.v20080604
-eclipse.launcher.version=1.0.100.v20080509-1800
------ end -------------------------------------
-
-
-Importing the projects in Eclipse
-=================================
-
-In the Java perspective, select "Import" -> "Existing Java projects", select
-the directory where this file is located.  The next panel should have four
-projects:
-
-net.sourceforge.pmd.eclipse
-net.sourceforge.pmd.eclipse.plugin
-pmd-eclipse-test
-pmd-eclipse-test-fragment
-
-
@@ -0,0 +1,122 @@
+PMD Eclipse Plugin
+==================
+
+Compilation
+-----------
+Simply run `mvn clean install`. The plugin's update site will be generated in
+`net.sourceforge.pmd.eclipse.p2updatesite/target/repository`. You can use this directory as
+an update site to install the new plugin version directly into your Eclipse.
+
+Importing the projects in Eclipse
+---------------------------------
+Make sure you have the Maven Integration (m2e - http://eclipse.org/m2e/) installed. Then you can
+import *Existing Maven Projects*.
+You should see 6 projects:
+
+* net.sourceforge.pmd.eclipse - that's the feature
+* net.sourceforge.pmd.eclipse.p2updatesite - generates the update site
+* net.sourceforge.pmd.eclipse.parent - the parent pom project
+* net.sourceforge.pmd.eclipse.plugin - the actual plugin code
+* net.sourceforge.pmd.eclipse.plugin.test - the (unit) tests for the plugin
+* net.sourceforge.pmd.eclipse.plugin.test.fragment - an example extension of the plugin used during the tests
+
+
+Releasing and updating the official eclipse update site
+-------------------------------------------------------
+
+    # Pick a release BUILDQUALIFIER (e.g. v20130420-0001) and update versions
+    E.g. version is: "4.0.0" and BUILDQUALIFIER is "v20130420-0001".
+    The complete version of the plugin will be "4.0.0.v20130420-0001
+    export BUILDQUALIFIER=$(date -u +v%Y%m%d-%H%M) && echo $BUILDQUALIFIER
+    
+    # Pick the version of the new release and the next development version
+    export VERSION=4.0.0
+    export NEXT=4.0.1
+    
+    # Define the location of the local copy of the update site
+    export UPDATE_SITE_MIRROR=/location/of/local/update-site/
+    
+    # Define your sourceforge login
+    export SFUSER=sf-user
+    
+    # First get a copy of the current update site
+    rsync -avhP $SFUSER@web.sourceforge.net:/home/frs/project/pmd/pmd-eclipse/update-site/ $UPDATE_SITE_MIRROR
+    # Create a release branch
+    git branch pmd-eclipse-plugin-rb-$VERSION
+    # Update master branch to the next -SNAPSHOT version.
+    mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=$NEXT-SNAPSHOT
+    # Update versions in n.s.p.e.p2updatesite/category.xml
+    sed -i -e "s/$VERSION.qualifier/$NEXT.qualifier/" net.sourceforge.pmd.eclipse.p2updatesite/category.xml
+    
+    # Update the ReleaseNotes with the release date and version and add a next version entry
+    vim ReleaseNotes.md
+    # Commit and push
+    git commit -a -m "Prepare next pmd-eclipse-plugin development version $NEXT-SNAPSHOT"
+    git push origin master
+    
+    # Checkout the release branch
+    git checkout pmd-eclipse-plugin-rb-$VERSION
+    # update versions with the BUILDQUALIFIER
+    mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=$VERSION.$BUILDQUALIFIER
+    # Update versions in n.s.p.e.p2updatesite/category.xml
+    sed -i -e "s/$VERSION.qualifier/$VERSION.$BUILDQUALIFIER/" net.sourceforge.pmd.eclipse.p2updatesite/category.xml
+    # Update the ReleaseNotes with the release date and version
+    vim ReleaseNotes.md
+    # Commit and tag
+    git commit -a -m "Prepare release pmd-eclipse-plugin $VERSION.$BUILDQUALIFIER"
+    git tag pmd-eclipse-plugin/$VERSION.$BUILDQUALIFIER
+    # Build the plugin
+    mvn clean install -Ppublish-to-update-site -Declipse.updatesite.path=$UPDATE_SITE_MIRROR
+
+    # Test the new update site with eclipse - it should contain the new version
+    # If everything is fine, push the local changes
+    git push origin master
+    git push origin tag pmd-eclipse-plugin/$VERSION.$BUILDQUALIFIER
+    # upload the official update site
+    rsync -avhP $UPDATE_SITE_MIRROR $SFUSER@web.sourceforge.net:/home/frs/project/pmd/pmd-eclipse/update-site/
+    # Cleanup the release branch which was only needed during the release process
+    git checkout master
+    git branch -D pmd-eclipse-plugin-rb-$VERSION
+
+Finally announce the new plugin version in the news section of SF: <https://sourceforge.net/p/pmd/news/>.
+You can use the following template:
+
+    PMD for Eclipse $VERSION released
+    
+    A new PMD for Eclipse plugin version has been released.
+    It is available via the update site: <https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/>
+    
+    * Release Notes: <https://github.com/pmd/pmd/blob/pmd-eclipse-plugin/$VERSION/pmd-eclipse-plugin/ReleaseNotes.md>
+
+
+
+
+
+Updating the used PMD version
+-----------------------------
+The parent pom contains the property `pmd.version`. This is used inside the plugin module, to resolve the dependencies.
+In order to change the PMD version, change this property and rebuild (`mvn clean package`). In case PMD has some
+changed (added/removed) transitive dependencies, you'll need to update `n.s.p.e.plugin/META-INF/MANIEFEST.MF` as well.
+All transitive dependencies are copied into the folder `n.s.p.e.plugin/target/lib` during the build.
+
+
+Useful References
+-----------------
+
+* <http://wiki.eclipse.org/Equinox/p2/Publisher>
+* <http://wiki.eclipse.org/Equinox_p2_Repository_Mirroring>
+* <http://wiki.eclipse.org/Category:Tycho>
+* <http://wiki.eclipse.org/Tycho/Additional_Tools>
+* <http://codeiseasy.wordpress.com/2012/07/26/managing-a-p2-release-repository-with-tycho/>
+* <http://wiki.eclipse.org/Tycho/Demo_Projects>
+* <http://wiki.eclipse.org/Tycho/Reference_Card>
+* <http://eclipse.org/tycho/sitedocs/index.html>
+* <https://docs.sonatype.org/display/M2ECLIPSE/Staging+and+releasing+new+M2Eclipse+release>
+* <http://wiki.eclipse.org/Tycho/Packaging_Types>
+* <http://wiki.eclipse.org/Tycho/Reproducible_Version_Qualifiers>
+* <http://www.vogella.com/articles/EclipseTycho/article.html>
+* <http://git.eclipse.org/c/tycho/org.eclipse.tycho-demo.git/tree/itp01/tycho.demo.itp01.tests/pom.xml>
+* <http://www.sonatype.com/people/2008/11/building-eclipse-plugins-with-maven-tycho/>
+* <http://zeroturnaround.com/labs/building-eclipse-plug-ins-with-maven-3-and-tycho/>
+* <https://github.com/open-archetypes/tycho-eclipse-plugin-archetype>
+* <http://wiki.eclipse.org/Tycho/How_Tos/Dependency_on_pom-first_artifacts>
@@ -0,0 +1,52 @@
+# PMD For Eclipse - Release Notes
+
+Installation instructions: <http://pmd.sourceforge.net/eclipse/>
+
+Eclipse Update Site: <https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/>
+
+
+## 31-October-2013: 4.0.2.v20131031-1124
+
+* Fixed Plugin does not execute custom xpath rules ([bug #1132])
+* Fixed After changing exclude filters violations are not cleared ([bug #1148])
+
+[bug #1132]: https://sourceforge.net/p/pmd/bugs/1132/
+[bug #1148]: https://sourceforge.net/p/pmd/bugs/1148/
+
+
+## 11-August-2013: 4.0.1.v20130811-0001
+
+* Updated PMD to 5.0.5
+* Fixed Build path exclusions not honored ([bug  #988])
+* Fixed right click to add reviewed comment missing ([bug #1052])
+* Fixed PMD Eclipse: How to ... documentation missing ([bug #1061])
+* Fixed Properties page: "Rule-Selection" should be disabled if project-local config is selected ([bug #1070])
+* Fixed Violations are reported multiple times ([bug #1071])
+* Fixed Exclude pattern does not work ([bug #1079])
+* Fixed SWTError: No more handles on Violation Outline View ([bug #1096])
+* Fixed Selecting non-duplicates during import doesn't work. ([bug #1110])
+* Fixed Eclipse log file will not be filled ([bug #1112])
+* Fixed PMD Eclipse plugin doesn't analyze project if it has non-existing source folders ([bug #1116])
+* Fixed An internal error occurred during: "RenderReport" ([bug #1117])
+* The official update site is now: <https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/>
+
+[bug  #988]: https://sourceforge.net/p/pmd/bugs/988/
+[bug #1052]: https://sourceforge.net/p/pmd/bugs/1052/
+[bug #1061]: https://sourceforge.net/p/pmd/bugs/1061/
+[bug #1070]: https://sourceforge.net/p/pmd/bugs/1070/
+[bug #1071]: https://sourceforge.net/p/pmd/bugs/1071/
+[bug #1079]: https://sourceforge.net/p/pmd/bugs/1079/
+[bug #1096]: https://sourceforge.net/p/pmd/bugs/1096/
+[bug #1110]: https://sourceforge.net/p/pmd/bugs/1110/
+[bug #1112]: https://sourceforge.net/p/pmd/bugs/1112/
+[bug #1116]: https://sourceforge.net/p/pmd/bugs/1116/
+[bug #1117]: https://sourceforge.net/p/pmd/bugs/1117/
+
+
+## 10-May-2013: 4.0.0.v20130510-1000
+
+* Updated PMD to 5.0.4
+* Fixed False Positive: LocalVariableCouldBeFinal ([bug #1075])
+
+[bug #1075]: http://sourceforge.net/p/pmd/bugs/1075/
+