aboutsummaryrefslogtreecommitdiffstats
path: root/roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md')
-rw-r--r--roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md b/roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md
new file mode 100644
index 000000000..47486e5c3
--- /dev/null
+++ b/roms/edk2/.pytool/Plugin/CharEncodingCheck/Readme.md
@@ -0,0 +1,18 @@
+# Character Encoding Check Plugin
+
+This CiBuildPlugin scans all the files in a package to make sure each file is
+correctly encoded and all characters can be read. Improper encoding causes
+tools to fail in some situations especially in different locals.
+
+## Configuration
+
+The plugin can be configured to ignore certain files.
+
+``` yaml
+"CharEncodingCheck": {
+ "IgnoreFiles": []
+}
+```
+### IgnoreFiles
+
+OPTIONAL List of file to ignore.