.pytool/Plugin/UncrustifyCheck: Add ignore file support

[mirror_edk2.git] / .pytool / Plugin / UncrustifyCheck / Readme.md

diff --git a/.pytool/Plugin/UncrustifyCheck/Readme.md b/.pytool/Plugin/UncrustifyCheck/Readme.md
index 0c46fd241a7a7127f4fd46319742dc68612b2c81..efe7a573e4fa965afd6d86ae4fa99c9751d8837f 100644 (file)
--- a/.pytool/Plugin/UncrustifyCheck/Readme.md
+++ b/.pytool/Plugin/UncrustifyCheck/Readme.md
@@ -41,6 +41,7 @@ The plugin can be configured with a few optional configuration options.
       "AdditionalIncludePaths": [], # Additional paths to check formatting (wildcards supported).\r
       "AuditOnly": False,           # Don't fail the build if there are errors.  Just log them.\r
       "ConfigFilePath": "",         # Custom path to an Uncrustify config file.\r
+      "IgnoreFiles": [],            # A list of file patterns to ignore.\r
       "IgnoreStandardPaths": [],    # Standard Plugin defined paths that should be ignored.\r
       "OutputFileDiffs": True,      # Output chunks of formatting diffs in the test case log.\r
                                     # This can significantly slow down the plugin on very large packages.\r
@@ -67,6 +68,12 @@ the test as skipped. This allows visibility into the failures without breaking t
 \r
 When specified in the config file, this is a package relative path to the Uncrustify configuration file.\r
 \r
+### `IgnoreFiles`\r
+\r
+This option supports .gitignore file and folder matching strings including wildcards.\r
+\r
+The files specified by this configuration option will not be processed by Uncrustify.\r
+\r
 ### `IgnoreStandardPaths`\r
 \r
 This plugin by default will check the below standard paths. A package configuration file can specify any of these paths\r