From 3c557f7ac1f756959b38c069b6d494d103a4ffde Mon Sep 17 00:00:00 2001
From: Tom Copeland <tomcopeland@users.sourceforge.net>
Date: Fri, 2 Jul 2004 15:26:42 +0000
Subject: [PATCH] Some clarifying notes suggested by Phil Shaw

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@2783 51baf565-9d33-0410-a72c-fc3788e3496d
---
 pmd/xdocs/credits.xml      | 1 +
 pmd/xdocs/integrations.xml | 6 ++++++
 pmd/xdocs/running.xml      | 5 +++++
 3 files changed, 12 insertions(+)

diff --git a/pmd/xdocs/credits.xml b/pmd/xdocs/credits.xml
index d938709cb3..0ffd4c6fd7 100644
--- a/pmd/xdocs/credits.xml
+++ b/pmd/xdocs/credits.xml
@@ -40,6 +40,7 @@
         </subsection>
         <subsection name="Contributors">
         <ul>
+            <li>Phil Shaw - documentation suggestions</li>
             <li>Todd Wright - XPath port of AtLeastOneConstructorRule, ConfusingTernaryExpression rule, reported missing ASTUnaryExpressionNotPlusMinus nodes</li>
             <li>Sreenivasa Viswanadha - reminded me to use BufferedInputStreams, grammar cleanup for Ctrl-Z problem</li>
             <li>Austin Moore - Integration with Omnicore's CodeGuide IDE</li>
diff --git a/pmd/xdocs/integrations.xml b/pmd/xdocs/integrations.xml
index 8aa14da06c..e40482f702 100644
--- a/pmd/xdocs/integrations.xml
+++ b/pmd/xdocs/integrations.xml
@@ -63,6 +63,12 @@
   </tr>
   </table>
       </subsection>
+        <subsection name="General comments">
+            <p>A general note - most plugins include the PMD jar file, which has the rulesets
+            inside it.  So even though the rulesets parameter that some plugins
+            use (i.e., "rulesets/unusedcode.xml") looks like a filesystem reference, it's really
+            being used by a getResourceAsStream() call to load it out of the PMD jar file.</p>
+        </subsection>
       <subsection name="Eclipse">
 <p>
 Integration into Eclipse is accomplished through the extensive
diff --git a/pmd/xdocs/running.xml b/pmd/xdocs/running.xml
index a6c558ff40..92771518d8 100644
--- a/pmd/xdocs/running.xml
+++ b/pmd/xdocs/running.xml
@@ -22,6 +22,11 @@ Avoid unused local variables such as 'fr'
 
 C:\tmp\pmd-1.8\pmd\etc&gt;
     </source>
+       <p>Note that the PMD binary distribution includes the ruleset files
+       inside the jar file - even though the "rulesets/unusedcode.xml" parameter
+ above looks like a filesystem reference, it's really being used by a getResourceAsStream() call
+ to load it out of the PMD jar file.  And the same applies to the example below.</p>
+
        <li>If you are using JDK 1.3 or you just want to run PMD without the batch file, you can do a:</li>
        <source>
 C:\data\pmd\pmd>java -cp lib\pmd-1.8.jar;lib\xercesImpl-2.0.2.jar;