Update documentation

TRAVIS_JOB_NUMBER=4388.2
TRAVIS_COMMIT_RANGE=34455b3051ca...79fa9d21373d
This commit is contained in:
Travis CI (pmd-bot)
2019-10-29 19:00:25 +00:00
parent dac4d0a5bd
commit 537433b311
3 changed files with 15 additions and 2 deletions

View File

@@ -5,8 +5,8 @@
<description>Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features.</description>
<link>https://pmd.github.io/pmd/</link>
<atom:link href="https://pmd.github.io/pmd/feed.xml" rel="self" type="application/rss+xml"/>
<pubDate>Tue, 29 Oct 2019 17:34:35 +0000</pubDate>
<lastBuildDate>Tue, 29 Oct 2019 17:34:35 +0000</lastBuildDate>
<pubDate>Tue, 29 Oct 2019 18:59:18 +0000</pubDate>
<lastBuildDate>Tue, 29 Oct 2019 18:59:18 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
</channel>

View File

@@ -1336,13 +1336,16 @@ server.</p>
<ul>
<li>core
<ul>
<li><a href="https://github.com/pmd/pmd/issues/1978">#1978</a>: [core] PMD fails on excluding unknown rules</li>
<li><a href="https://github.com/pmd/pmd/issues/2014">#2014</a>: [core] Making add(SourceCode sourceCode) public for alternative file systems</li>
<li><a href="https://github.com/pmd/pmd/issues/2020">#2020</a>: [core] Wrong deprecation warnings for unused XPath attributes</li>
<li><a href="https://github.com/pmd/pmd/issues/2036">#2036</a>: [core] Wrong include/exclude patterns are silently ignored</li>
<li><a href="https://github.com/pmd/pmd/issues/2048">#2048</a>: [core] Enable type resolution by default for XPath rules</li>
<li><a href="https://github.com/pmd/pmd/issues/2067">#2067</a>: [core] Build issue on Windows</li>
<li><a href="https://github.com/pmd/pmd/pull/2068">#2068</a>: [core] Rule loader should use the same resources loader for the ruleset</li>
<li><a href="https://github.com/pmd/pmd/issues/2071">#2071</a>: [ci] Add travis build on windows</li>
<li><a href="https://github.com/pmd/pmd/issues/2072">#2072</a>: [test][core] Not enough info in “test setup error” when numbers of lines do not match</li>
<li><a href="https://github.com/pmd/pmd/issues/2082">#2082</a>: [core] Incorrect logging of deprecated/renamed rules</li>
</ul>
</li>
<li>java

View File

@@ -1350,6 +1350,8 @@ category, then PMD would fail before starting the analysis.</li>
<h4 id="configuring-individual-rules"><a href="pmd_userdocs_configuring_rules.html">Configuring individual rules</a></h4>
<p>How you can configure individual rules is described on <a href="pmd_userdocs_configuring_rules.html">Configuring Rules</a>.</p>
<h3 id="bulk-adding-rules">Bulk-adding rules</h3>
<p>You can also reference rules in bulk by referencing a complete category or ruleset, possibly excluding certain rules, like in the following:</p>
@@ -1364,6 +1366,14 @@ category, then PMD would fail before starting the analysis.</li>
<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> Path separators in the source file path are normalized to be the <code class="highlighter-rouge">/</code> character within PMD, so the same ruleset can be used on multiple platforms transparently.</div>
<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> Referencing a complete category or ruleset means, youll also get automatically any
changes for this ruleset. If new rules are added, then these are automatically activated for you. If rules
are deprecated, then these rules are automatically deactivated. This might or
not might be, what you want. This can happen, if a new version of PMD provides a new rule and or deprecates
existing rules. If you want to have
complete control over the rules, that you are using, then it is recommended to add each rule separately via
a single rule reference.</div>
<h3 id="filtering-the-processed-files">Filtering the processed files</h3>
<p>You can exclude some files from being processed by a ruleset using <strong>exclude patterns</strong>, with an optional overridding <strong>include pattern</strong>. A file will be excluded from processing <em>when there is a matching exclude pattern, but no matching include pattern</em>. This exclude/include technique works regardless of how PMD is used (e.g. command line, IDE, Ant), making it easier to keep application of your PMD rules consistent throughout your environment. Here is an example:</p>