added page on running PMD

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@41 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland 2002-06-25 13:25:48 +00:00
parent 11ebf90476
commit 2698e007fb
2 changed files with 37 additions and 0 deletions

View File

@ -14,6 +14,7 @@
<item name="Ant Task" href="/ant-task.html" />
<item name="Credits" href="/credits.html" />
<item name="Similar Projects" href="/similar-projects.html" />
<item name="Running PMD" href="/running.html" />
</menu>
</body>
</project>

36
pmd/xdocs/running.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0"?>
<document>
<properties>
<author email="tom@infoether.com">Tom Copeland</author>
<title>Running PMD</title>
</properties>
<body>
<section name="Running PMD via command line">
<ul>
<li>Build PMD by going to the etc directory and typing 'ant clean'
<li>Type run 'filename', i.e.:
<pre>
C:\data\pmd\pmd\etc>run c:\data\pmd\pmd\test-data\Unused1.java
C:\data\pmd\pmd\etc>set CLASSPATH=../build/
C:\data\pmd\pmd\etc>java net.sourceforge.pmd.PMD c:\data\pmd\pmd\test-data\Unuse
d1.java
<pmd><file>
<name>c:\data\pmd\pmd\test-data\Unused1.java</name><ruleviolation><line>5</line>
<description>Found unused local variable 'fr'</description></ruleviolation></fil
e>
</pmd>
</pre>
</ul>
</section>
<section name="Running PMD via Ant">
<ul>
<li>Build PMD by going to the etc directory and typing 'ant clean'
<li>Add a new Ant target to your build file - <a href="ant-task.html">here's an example</a>.
<li>Make sure the PMD class files are on your classpath.
<li>Run Ant like you normally do.
</ul>
</section>
</body>
</document>