From aaac4d322ca883df03eacef6d33e0967aca27826 Mon Sep 17 00:00:00 2001 From: Tom Copeland Date: Fri, 13 Sep 2002 15:44:33 +0000 Subject: [PATCH] *** empty log message *** git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@941 51baf565-9d33-0410-a72c-fc3788e3496d --- pmd/etc/changelog.txt | 2 + pmd/etc/doing_the_next_pmd_release.txt | 4 ++ pmd/etc/readme.txt | 67 ++++++++++++++++++++++++++ 3 files changed, 73 insertions(+) create mode 100644 pmd/etc/readme.txt diff --git a/pmd/etc/changelog.txt b/pmd/etc/changelog.txt index 85c687ffcf..331625faa7 100644 --- a/pmd/etc/changelog.txt +++ b/pmd/etc/changelog.txt @@ -1,3 +1,5 @@ +???? 2002 - ???: + September 12 2002 - 1.0rc2: Added new rules: JUnitSpellingRule, JUnitStaticSuiteRule, StringInstantiationRule Added new rulesets - junit, strings. diff --git a/pmd/etc/doing_the_next_pmd_release.txt b/pmd/etc/doing_the_next_pmd_release.txt index 0e3c67b63e..54f77551ba 100644 --- a/pmd/etc/doing_the_next_pmd_release.txt +++ b/pmd/etc/doing_the_next_pmd_release.txt @@ -23,12 +23,16 @@ Prepare binary release: rmdir /q /s c:\tmp\pmd mkdir -p c:\tmp\pmd\etc mkdir c:\tmp\pmd\lib +mkdir -p c:\tmp\pmd\docs\javadoc copy run.bat c:\tmp\pmd\etc copy build.xml c:\tmp\pmd\etc copy cpdgui.bat c:\tmp\pmd\etc +copy readme.txt c:\tmp\pmd\etc +copy changelog.txt c:\tmp\pmd\etc copy ..\lib\pmd-1.0rc2.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 +generate the web site and copy the javadoc into c:\tmp\pmd\docs\javadoc Zip it up, rename it pmd-bin-1.0rc2.zip All is well, so time to tag: diff --git a/pmd/etc/readme.txt b/pmd/etc/readme.txt new file mode 100644 index 0000000000..b153daf8fa --- /dev/null +++ b/pmd/etc/readme.txt @@ -0,0 +1,67 @@ +PMD + +Contents: +Overview +Running PMD from the command-line on Win32 +Running PMD from the command-line on Unix + + +OVERVIEW +PMD is a Java source code analysis tool. It finds unused variables, empty catch blocks, +unnecessary object creation, and so forth. + + +HOW TO RUN PMD FROM THE COMMAND LINE (WIN32) +-download the binary release +-unzip it somewhere +-cd into the pmd\etc\ directory + +C:\tmp\tmp_pmd>cd pmd\etc +C:\tmp\tmp_pmd\pmd\etc> + +-run PMD on a Java source file + +C:\tmp\tmp_pmd\pmd\etc>run c:\data\pmd\pmd\test-data\Unused1.java html rulesets/unusedcode.xml +PMD + + + + + + + +
FileLineProblem
c:\data\pmd\pmd\test-data\Unused1.java5Avoid unused local variables such as 'fr'
+C:\tmp\tmp_pmd\pmd\etc> + + +HOW TO RUN PMD FROM THE COMMAND LINE (UNIX) +-download the binary release +-unzip it + +[build@ul020-dmz tmp_pmd]$ unzip -q pmd-bin-1.0rc2.zip + +-cd into the pmd/etc/ directory + +[build@ul020-dmz tmp_pmd]$ cd pmd/etc/ + +-run PMD on a Java source file + +[build@ul020-dmz etc]$ java -jar ../lib/pmd-1.0rc2.jar Foo.java html rulesets/unusedcode.xml +PMD + + + + + + + +
FileLineProblem
Foo.java48Avoid unused private fields such as '_tasks'
+[build@ul020-dmz etc]$ + +-if you send in a directory as the first parameter, PMD will run recursively on all files and subdirectories + + + + + +