summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPierre Gondois <Pierre.Gondois@arm.com>2021-02-10 10:03:43 +0000
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2021-04-28 12:03:51 +0000
commitec9683ec0fe9b3b42ebc8705dfbf63e9fbc96f5f (patch)
treeea09a8450cdc27b8277fefd39b80b152ef1c1ed0
parenta4cf19597f179a6af7dc56cf0c20e2f2f834db77 (diff)
downloadedk2-ec9683ec0fe9b3b42ebc8705dfbf63e9fbc96f5f.tar.gz
edk2-ec9683ec0fe9b3b42ebc8705dfbf63e9fbc96f5f.tar.bz2
edk2-ec9683ec0fe9b3b42ebc8705dfbf63e9fbc96f5f.zip
.pytool: Document LicenseCheck and EccCheck
Add an entry in the documentation for the LicenseCheck and EccCheck plugins. Cc: Bret Barkelew <bret.barkelew@microsoft.com> Cc: Sean Brogan <sean.brogan@microsoft.com> Cc: Leif Lindholm <leif@nuviainc.com> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org> Cc: Sami Mujawar <sami.mujawar@arm.com> Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com> Acked-by: Bret Barkelew <bret.barkelew@microsoft.com> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
-rw-r--r--.pytool/Readme.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/.pytool/Readme.md b/.pytool/Readme.md
index eca86c6a82..f650550796 100644
--- a/.pytool/Readme.md
+++ b/.pytool/Readme.md
@@ -254,6 +254,16 @@ Install
More cspell info: https://github.com/streetsidesoftware/cspell
+### License Checking - LicenseCheck
+
+Scans all new added files in a package to make sure code is contributed under
+BSD-2-Clause-Patent.
+
+### Ecc tool - EccCheck
+
+Run the Ecc tool on the package. The Ecc tool is available in the BaseTools
+package. It checks that the code complies to the EDKII coding standard.
+
## PyTool Scopes
Scopes are how the PyTool ext_dep, path_env, and plugins are activated. Meaning