Issue checkstyle#8269: Update doc for BeforeExecutionExclusionFileFilter

Ritik2604 · Apr 3, 2021 · 5a92493 · 5a92493
1 parent 5dd91f9
commit 5a92493
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.../java/com/puppycrawl/tools/checkstyle/filefilters/BeforeExecutionExclusionFileFilter.java b/.../java/com/puppycrawl/tools/checkstyle/filefilters/BeforeExecutionExclusionFileFilter.java
@@ -74,6 +74,13 @@
  * &lt;/module&gt;
  * </pre>
  * <p>
+ * To configure the filter to ignore some Checks in maven test folder by modifying {@code config/suppressions.xml}:
+ * </p>
+ *
+ * <pre>
+ * &lt;suppress checks=&quot;EmptyBlock&quot; files=&quot;.*[\\/]src[\\/]test[\\/]&quot;/&gt;
+ * </pre>
+ * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
  * </p>
  *

diff --git a/src/xdocs/config_filefilters.xml b/src/xdocs/config_filefilters.xml
@@ -79,6 +79,12 @@
     value=&quot;^(?!.*(Remote\.java|Client\.java|[\\/]Remote\.java|[\\/]Client\.java)).*$&quot;/&gt;
 &lt;/module&gt;
         </source>
+        <p>
+          To configure the filter to ignore some Checks in maven test folder by modifying <code>config/suppressions.xml</code>:
+        </p>
+        <source><![CDATA[
+<suppress checks="EmptyBlock" files=".*[\\/]src[\\/]test[\\/]"/>
+        ]]></source>
       </subsection>
       <subsection name="Example of Usage" id="BeforeExecutionExclusionFileFilter_Example_of_Usage">
         <ul>