diff --git a/pmd/etc/build.xml b/pmd/etc/build.xml index 0387d54546..78a489e0f9 100644 --- a/pmd/etc/build.xml +++ b/pmd/etc/build.xml @@ -3,6 +3,7 @@ + @@ -24,12 +25,17 @@ - + + + + + + - + diff --git a/pmd/etc/changelog.txt b/pmd/etc/changelog.txt index 9a8f710d12..cd76e3bcad 100644 --- a/pmd/etc/changelog.txt +++ b/pmd/etc/changelog.txt @@ -1,8 +1,10 @@ July 03 2002 - 0.3: Added new rules: UseSingletonRule, ShortVariableRule, LongVariableRule, ShortMethodNameRule -Removed the 'text' report format. -Moved rules into RuleSets which are defined in XML files in the ruleset directory. -Added a 'failonerror' attribute to the Ant task. +Moved rules into RuleSets which are defined in XML files in the ruleset directory +Ant task: +-Added a 'failonerror' attribute +-Changed 'rulesettype' to 'rulesetfiles' +-Removed 'text' report format; only 'html' and 'xml' are available now June 27 2002 - 0.2: Added new rules: IfElseStmtsMustUseBracesRule, EmptyWhileStmtRule diff --git a/pmd/etc/doing_the_next_pmd_release.txt b/pmd/etc/doing_the_next_pmd_release.txt index 8854b31324..ff0a94bdc0 100644 --- a/pmd/etc/doing_the_next_pmd_release.txt +++ b/pmd/etc/doing_the_next_pmd_release.txt @@ -1,8 +1,5 @@ update the xdocs: --added new ruleset to Ant task - design --modified Ant task - removed 'text' format report --modified Ant task - changed 'rulesettype' to 'rulesetfiles' --modified Ant task - added 'failonerror' attribute +-modified Ant task (see changelog for details) -run.bat/sh third param is a rule set file update run.bat to point to pmd-0.3.jar update the changelog @@ -11,9 +8,8 @@ ant dist ant test Do all the tests run? OK, then: ant dist -rename jar to pmd-0.3.jar cvs add -kb pmd-0.3.jar -cvs rm pmd-0.1.jar +cvs rm pmd-0.2.jar cvs ci -m "adding new jar, removing old one" cd c:\data\pmd cvs rtag -D tomorrow "pmd_release_0_3" pmd diff --git a/pmd/etc/run.bat b/pmd/etc/run.bat index 077003b18b..49e8be2c78 100755 --- a/pmd/etc/run.bat +++ b/pmd/etc/run.bat @@ -1,5 +1,5 @@ @echo off -set CLASSPATH=../lib/pmd-0.2.jar +set CLASSPATH=../lib/pmd-0.3.jar set FILE=%1% set FORMAT=%2% set RULESETFILE=%3% diff --git a/pmd/xdocs/ant-task.xml b/pmd/xdocs/ant-task.xml index 4758205a03..ff27924624 100644 --- a/pmd/xdocs/ant-task.xml +++ b/pmd/xdocs/ant-task.xml @@ -2,6 +2,7 @@ + David Dixon-Peugh Tom Copeland Ant Task @@ -15,7 +16,6 @@ - @@ -27,19 +27,25 @@ - - + + - - + + - + + + + + +
AttributeDescription Required
verboseVerbose output - just the name of each file processed.YesVerbose output - names of files processed, rule counts, etc.No
rulesettypeThe set of rules to use (all, general, cougaar)rulesetfilesA comma delimited list of ruleset files ('rulesets/basic.xml,rulesets/design.xml'). If you write + your own ruleset files, they must be on the classpath. Yes
formatThe report format (xml, text, html)The report format (xml, html) Yes
failonerrorWhether on not to fail the build if PMD finds any problemsNo
@@ -48,7 +54,16 @@ - + + + + + +
+ + + + diff --git a/pmd/xdocs/running.xml b/pmd/xdocs/running.xml index e2aa2ece76..941bb2042e 100644 --- a/pmd/xdocs/running.xml +++ b/pmd/xdocs/running.xml @@ -9,9 +9,9 @@
    -
  • Type run <filename> <report format>, <rule set>i.e.:
  • +
  • Type run <filename> <report format>, <rule set file>i.e.:
  • -    C:\data\pmd\pmd\etc>run c:\data\pmd\pmd\test-data\Unused1.java xml general
    +    C:\data\pmd\pmd\etc>run c:\data\pmd\pmd\test-data\Unused1.java xml rulesets/unusedcode.xml
         <pmd>
         <file>
         <name>c:\data\pmd\pmd\test-data\Unused1.java</name><ruleviolation><line>5</line>
    @@ -24,8 +24,8 @@
        
    -
  • Add a new Ant target to your build file - here's an example.
  • -
  • Make sure the pmd-0.2.jar file is on your classpath.
  • +
  • Add a new Ant target to your build file - here's some examples.
  • +
  • Make sure the pmd-0.3.jar file is on your classpath.
  • Run Ant like you normally do.