From 988cb86b1a8b4e41e99386a345bc519469df4591 Mon Sep 17 00:00:00 2001
From: Tom Copeland <tomcopeland@users.sourceforge.net>
Date: Wed, 22 Jan 2003 20:14:35 +0000
Subject: [PATCH] tweak

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@1364 51baf565-9d33-0410-a72c-fc3788e3496d
---
 pmd/etc/doing_the_next_pmd_release.txt |  4 +-
 pmd/xdocs/ant-task.xml                 | 58 +++++++++++++-------------
 2 files changed, 32 insertions(+), 30 deletions(-)

diff --git a/pmd/etc/doing_the_next_pmd_release.txt b/pmd/etc/doing_the_next_pmd_release.txt
index 1a8d6d4836..b41abba1d6 100644
--- a/pmd/etc/doing_the_next_pmd_release.txt
+++ b/pmd/etc/doing_the_next_pmd_release.txt
@@ -37,7 +37,7 @@ copy ..\lib\pmd-1.02.jar c:\tmp\pmd\lib
 copy ..\lib\xmlParserAPIs-2.0.2.jar c:\tmp\pmd\lib
 copy ..\lib\xercesImpl-2.0.2.jar c:\tmp\pmd\lib
 copy the docs directory over to c:\tmp\pmd -- how to do this on cmd line?
-copy all the test classes and data into the release 
+copy the test-data directory over to c:\tmp\pmd
 Zip it up, rename it pmd-bin-1.02.zip
 
 Time to tag:
@@ -57,7 +57,7 @@ and then retag everything
 
 FTP the zip file to SF
 ftp upload.sourceforge.net
-generic userid/password: anonymous/tomcopeland@users.sourceforge.net
+generic userid/password: anonymous/tom@infoether.com
 cd incoming
 bin
 put pmd-bin-1.02.zip
diff --git a/pmd/xdocs/ant-task.xml b/pmd/xdocs/ant-task.xml
index eed4627764..ea13cd38d8 100644
--- a/pmd/xdocs/ant-task.xml
+++ b/pmd/xdocs/ant-task.xml
@@ -20,27 +20,17 @@
     <td align="center" valign="top"><b>Required</b></td>
   </tr>
   <tr>
-    <td valign="top">reportfile</td>
-    <td valign="top">The file to which the report is written.</td>
+    <td valign="top">formatter</td>
+    <td valign="top">Specifies formats and files to which the report is written. Can be of type 'xml', 'text', or 'html'.  See example below.</td>
     <td valign="top" align="center">Yes</td>
 
   </tr>
-  <tr>
-    <td valign="top">verbose</td>
- 	<td valign="top">Verbose output - names of files processed, rule counts, etc.</td>
-    <td valign="top" align="center">No</td>
-  </tr>
   <tr>
     <td valign="top">rulesetfiles</td>
     <td valign="top">A comma delimited list of ruleset files ('rulesets/basic.xml,rulesets/design.xml').  If you write
     your own ruleset files, you can put them on the classpath and plug them in here.</td>
     <td valign="top" align="center">Yes</td>
   </tr>
-  <tr>
-    <td valign="top">format</td>
-    <td valign="top">The report format (xml, html)</td>
-    <td valign="top" align="center">Yes</td>
-  </tr>
   <tr>
     <td valign="top">failonerror</td>
     <td valign="top">Whether or not to fail the build if PMD finds any problems</td>
@@ -51,29 +41,41 @@
     <td valign="top">Whether or not to print any problems found to the Ant log/console</td>
     <td valign="top" align="center">No</td>
   </tr>
+    <tr>
+      <td valign="top">shortFilenames</td>
+      <td valign="top">Places truncated filenames in the report.  This can reduce your report file size by 15%-20%.</td>
+      <td valign="top" align="center">No</td>
+    </tr>
+    <tr>
+      <td valign="top">verbose</td>
+       <td valign="top">Verbose output - names of files processed, rule counts, etc.</td>
+      <td valign="top" align="center">No</td>
+    </tr>
 </table>
 
       </subsection>
       <subsection name="Examples">
 <source>
 <![CDATA[
-<target name="pmd">
-  <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" />
-  <pmd reportFile="C:\foo.xml" rulesetfiles="rulesets/unusedcode.xml" format="xml">
-    <fileset dir="C:\j2sdk1.4.0\src\">
-      <include name="**/*.java"/>
-    </fileset>
-  </pmd>
-</target>
+    <target name="pmd">
+        <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask"/>
+        <pmd rulesetfiles="rulesets/imports.xml" shortFilenames="true">
+            <formatter type="html" toFile="pmd_report.html"/>
+            <fileset dir="C:\j2sdk1.4.1_01\src\java\lang\">
+                <include name="**/*.java"/>
+            </fileset>
+        </pmd>
+    </target>
 
-<target name="pmd">
-  <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" />
-  <pmd reportFile="C:\foo.xml" verbose="false" rulesetfiles="rulesets/basic.xml,rulesets/design.xml" format="xml" failonerror="no">
-    <fileset dir="C:\j2sdk1.4.0\src\">
-      <include name="**/*.java"/>
-    </fileset>
-  </pmd>
-</target>
+    <target name="pmd">
+        <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask"/>
+        <pmd rulesetfiles="rulesets/imports.xml,rulesets/unusedcode.xml" failonerror="no">
+            <formatter type="xml" toFile="pmd_report.xml"/>
+            <fileset dir="C:\j2sdk1.4.1_01\src\java\lang\">
+                <include name="**/*.java"/>
+            </fileset>
+        </pmd>
+    </target>
 ]]>
 </source>
       </subsection>