Re: [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck


Sami Mujawar
 

Hi Pierre,

 

Thank you for this patch.

 

Reviewed-by: Sami Mujawar <sami.mujawar@...>

 

Regards,

 

Sami Mujawar

 

From: Pierre.Gondois@... <Pierre.Gondois@...>
Date: Wednesday, 21 April 2021 at 13:21
To: devel@edk2.groups.io <devel@edk2.groups.io>, Sami Mujawar <Sami.Mujawar@...>, leif@... <leif@...>, ardb+tianocore@... <ardb+tianocore@...>, sean.brogan@... <sean.brogan@...>, Bret.Barkelew@... <Bret.Barkelew@...>
Subject: [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck

From: Pierre Gondois <Pierre.Gondois@...>

Add an entry in the documentation for the LicenseCheck and
EccCheck plugins.

Signed-off-by: Pierre Gondois <Pierre.Gondois@...>
---
 .pytool/Readme.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/.pytool/Readme.md b/.pytool/Readme.md
index eca86c6a822d..f6505507966a 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
--
2.17.1

Join devel@edk2.groups.io to automatically receive all group messages.