phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=2962.2
TRAVIS_COMMIT_RANGE=de0fd962cab0...063c906c7df2
This commit is contained in:
Travis CI (pmd-bot)
2018-10-26 17:54:10 +00:00
parent cfed2ee7e7
commit 0950d31255
3 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
feed.xml
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>Fri, 26 Oct 2018 16:44:13 +0000</pubDate>
<lastBuildDate>Fri, 26 Oct 2018 16:44:13 +0000</lastBuildDate>
<pubDate>Fri, 26 Oct 2018 17:53:50 +0000</pubDate>
<lastBuildDate>Fri, 26 Oct 2018 17:53:50 +0000</lastBuildDate>
<generator>Jekyll v3.7.4</generator>
</channel>

10
pmd_release_notes.html
View File

@ -1280,6 +1280,7 @@ as comments are recognized as such and ignored.</p>
<ul>
<li>all
<ul>
<li><a href="https://github.com/pmd/pmd/issues/649">#649</a>: [core] Exclude specific files from command line</li>
<li><a href="https://github.com/pmd/pmd/issues/1272">#1272</a>: [core] Could not find or load main class when using symlinked run.sh</li>
<li><a href="https://github.com/pmd/pmd/issues/1377">#1377</a>: [core] LanguageRegistry uses default class loader when invoking ServiceLocator</li>
<li><a href="https://github.com/pmd/pmd/issues/1394">#1394</a>: [doc] How to configure “-cache <path>"</path></li>
@ -1317,6 +1318,14 @@ as comments are recognized as such and ignored.</p>
<h3 id="api-changes">API Changes</h3>
<ul>
<li>PMD has a new CLI option <code class="highlighter-rouge">-ignorelist</code>. With that, you can provide a file containing a comma-delimit list of files,
that should be excluded during analysis. The ignorelist is applied after the files have been selected
via <code class="highlighter-rouge">-dir</code> or <code class="highlighter-rouge">-filelist</code>, which means, if the file is in both lists, then it will be ignored.
Note: there is no corresponding option for the Ant task, since the feature is already available via
Ant’s FileSet include/exclude filters.</li>
</ul>
<h3 id="external-contributions">External Contributions</h3>
<ul>
@ -1333,6 +1342,7 @@ as comments are recognized as such and ignored.</p>
<li><a href="https://github.com/pmd/pmd/pull/1398">#1398</a>: [all] Upgrading SLF4J from 1.7.12 to 1.7.25 - <a href="https://github.com/Thunderforge">Thunderforge</a></li>
<li><a href="https://github.com/pmd/pmd/pull/1401">#1401</a>: [all] Replacing IOUtils.closeQuietly(foo) with try-with-resources statements - <a href="https://github.com/Thunderforge">Thunderforge</a></li>
<li><a href="https://github.com/pmd/pmd/pull/1406">#1406</a>: [jsp] Fix issue 1402: JspTokenManager has a problem about jsp scriptlet - <a href="https://github.com/JustPRV">JustPRV</a></li>
<li><a href="https://github.com/pmd/pmd/pull/1411">#1411</a>: [core] Add ignore file path functionality - <a href="https://github.com/darakian">Jon Moroney</a></li>
<li><a href="https://github.com/pmd/pmd/pull/1414">#1414</a>: [doc] Fix broken link. Fixes #1412 - <a href="https://github.com/johanhammar">Johan Hammar</a></li>
</ul>

28
pmd_userdocs_cli_reference.html
View File

@ -1405,7 +1405,7 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<tr>
<td><a style="pointer-events: none; cursor: default;" name="cache"><code>-cache&nbsp;&lt;path&gt;</code></a></td>
<td><a style="pointer-events: none; cursor: default;" name="cache"><code>-cache&nbsp;&lt;filepath&gt;</code></a></td>
<td>Specify the location of the cache file for incremental analysis.
This should be the full path to the file, including the desired file name (not just the parent directory).
If the file doesn't exist, it will be created on the first run. The file will be overwritten on each run
@ -1500,7 +1500,7 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<tr>
<td><a style="pointer-events: none; cursor: default;" name="filelist"><code>-filelist&nbsp;&lt;files&gt;</code></a></td>
<td><a style="pointer-events: none; cursor: default;" name="filelist"><code>-filelist&nbsp;&lt;filepath&gt;</code></a></td>
<td>Path to file containing a comma delimited list of files to analyze.
If this is given, then you don't need to provide <code>-dir</code>.</td>
<td><code></code></td>
@ -1519,6 +1519,30 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<!-- fragment id in the page -->
<tr>
<td><a style="pointer-events: none; cursor: default;" name="ignorelist"><code>-ignorelist&nbsp;&lt;filepath&gt;</code></a></td>
<td>Path to file containing a comma delimited list of files to ignore.
This option can be combined with <code>-dir</code> and <code>-filelist</code>.
This ignore list takes precedence over any files in the filelist.</td>
<td><code></code></td>
<td></td>
</tr>
<!-- Row of the CLI reference table, describing an option -->
<!-- Rows can be linked to the name of the option (without leading dash) -->
<!-- Argument summary: -->
<!-- options: comma separated list of aliases for the option.-->
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
<!-- description: description, you can use "some" inline markdown -->
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
<!-- languages: languages to which the option applies -->
<!-- default: default value -->
<!-- fragment id in the page -->