[edk2-devel] [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck

[Sami Mujawar]

Hi Pierre,

Thank you for this patch.

Reviewed-by: Sami Mujawar <sami.mujawar at arm.com<mailto:sami.mujawar at arm.com>>

Regards,

Sami Mujawar

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

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

Signed-off-by: Pierre Gondois <Pierre.Gondois at arm.com>
---
 .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


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74362): https://edk2.groups.io/g/devel/message/74362
Mute This Topic: https://groups.io/mt/82258514/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/edk2-devel-archive/attachments/20210422/9cbcbaf4/attachment.htm>