[doc] Documentation update for --show-suppressed flag (#5230)

Merge pull request #5230 from dschach:master

.all-contributorsrc

@@ -7753,7 +7753,8 @@
       "profile": "https://github.com/dschach",
       "contributions": [
         "bug",
-        "code"
+        "code",
+        "doc"
       ]
     },
     {

docs/pages/pmd/projectdocs/credits.md

@@ -226,7 +226,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/davidmichaelkarr"><img src="https://avatars.githubusercontent.com/u/5566419?v=4?s=100" width="100px;" alt="David M. Karr (fullname at gmail.com)"/><br /><sub><b>David M. Karr (fullname at gmail.com)</b></sub></a><br /><a href="https://github.com/pmd/pmd/issues?q=author%3Adavidmichaelkarr" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/DavidRenz"><img src="https://avatars.githubusercontent.com/u/8180433?v=4?s=100" width="100px;" alt="David Renz"/><br /><sub><b>David Renz</b></sub></a><br /><a href="https://github.com/pmd/pmd/commits?author=DavidRenz" title="Code">💻</a> <a href="https://github.com/pmd/pmd/issues?q=author%3ADavidRenz" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/David-Renz"><img src="https://avatars.githubusercontent.com/u/8180460?v=4?s=100" width="100px;" alt="David Renz"/><br /><sub><b>David Renz</b></sub></a><br /><a href="https://github.com/pmd/pmd/issues?q=author%3ADavid-Renz" title="Bug reports">🐛</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dschach"><img src="https://avatars.githubusercontent.com/u/636977?v=4?s=100" width="100px;" alt="David Schach"/><br /><sub><b>David Schach</b></sub></a><br /><a href="https://github.com/pmd/pmd/issues?q=author%3Adschach" title="Bug reports">🐛</a> <a href="https://github.com/pmd/pmd/commits?author=dschach" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dschach"><img src="https://avatars.githubusercontent.com/u/636977?v=4?s=100" width="100px;" alt="David Schach"/><br /><sub><b>David Schach</b></sub></a><br /><a href="https://github.com/pmd/pmd/issues?q=author%3Adschach" title="Bug reports">🐛</a> <a href="https://github.com/pmd/pmd/commits?author=dschach" title="Code">💻</a> <a href="https://github.com/pmd/pmd/commits?author=dschach" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/dawiddc"><img src="https://avatars.githubusercontent.com/u/26235980?v=4?s=100" width="100px;" alt="Dawid Ciok"/><br /><sub><b>Dawid Ciok</b></sub></a><br /><a href="https://github.com/pmd/pmd/issues?q=author%3Adawiddc" title="Bug reports">🐛</a> <a href="https://github.com/pmd/pmd/commits?author=dawiddc" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Debamoy"><img src="https://avatars.githubusercontent.com/u/44639649?v=4?s=100" width="100px;" alt="Debamoy Datta"/><br /><sub><b>Debamoy Datta</b></sub></a><br /><a href="https://github.com/pmd/pmd/commits?author=Debamoy" title="Code">💻</a></td>
     </tr>

docs/pages/pmd/userdocs/cli_reference.md

@@ -159,7 +159,7 @@ The tool comes with a rather extensive help text, simply running with `--help`!
                description="Path to a file to which report output is written. The file is created if it does not exist. If this option is not specified, the report is rendered to standard output."
     %}
     {% include custom/cli_option_row.html options="--show-suppressed"
-               description="Causes the suppressed rule violations to be added to the report."
+               description="Causes the suppressed rule violations to be added to the report if supported by the report format. See [PMD Report formats](pmd_userdocs_report_formats.html) for details."
     %}
     {% include custom/cli_option_row.html options="--suppress-marker"
                option_arg="marker"

docs/pages/pmd/userdocs/pmd_report_formats.md

@@ -18,7 +18,7 @@ The header of the sections below are used to select the format on the command li
 arguments to the `--format` option. When a format accepts *properties*,
 those can be specified with the `--property` / `-P` option on the command-line.
 
-{% include note.html content="Suppressed violations are only reported, if the CLI parameter `--show-suppressed` is set." %}
+{% include note.html content="Suppressed violations are only reported, if the CLI parameter `--show-suppressed` is set and if the format supports showing suppressed violations. Currently only html, summaryhtml and xml show suppressed violations." %}
 
 ## sarif
 

docs/pages/release_notes.md

@@ -59,6 +59,7 @@ What changes?
   * [#5059](https://github.com/pmd/pmd/issues/5059): \[core] xml output doesn't escape CDATA inside its own CDATA
   * [#5201](https://github.com/pmd/pmd/issues/5201): \[core] PMD sarif schema file points to nonexistent location
   * [#5222](https://github.com/pmd/pmd/issues/5222): \[core] RuleReference/RuleSetWriter don't handle changed default property values correctly
+  * [#5229](https://github.com/pmd/pmd/issues/5229): \[doc] CLI flag `--show-suppressed` needs to mention xml, html, summaryhtml
 * java
   * [#5190](https://github.com/pmd/pmd/issues/5190): \[java] NPE in type inference
 * java-codestyle
@@ -73,6 +74,7 @@ What changes?
 * [#5202](https://github.com/pmd/pmd/pull/5202): \[core] Sarif format: refer to schemastore.org - [David Schach](https://github.com/dschach) (@dschach)
 * [#5208](https://github.com/pmd/pmd/pull/5208): \[doc] Added Codety to "Tools / Integrations" - [Tony](https://github.com/random1223) (@random1223)
 * [#5224](https://github.com/pmd/pmd/pull/5224): \[java] Fix #5068: Class incorrectly identified as non-instantiatable - [Lukas Gräf](https://github.com/lukasgraef) (@lukasgraef)
+* [#5230](https://github.com/pmd/pmd/pull/5230): \[doc] Documentation update for --show-suppressed flag - [David Schach](https://github.com/dschach) (@dschach)
 
 {% endtocmaker %}
 

pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/PmdCommand.java

@@ -138,7 +138,7 @@ public class PmdCommand extends AbstractAnalysisPmdSubcommand<PMDConfiguration>
         this.benchmark = benchmark;
     }
 
-    @Option(names = "--show-suppressed", description = "Report should show suppressed rule violations.")
+    @Option(names = "--show-suppressed", description = "Report should show suppressed rule violations if supported by the report format.")
     public void setShowSuppressed(final boolean showSuppressed) {
         this.showSuppressed = showSuppressed;
     }