[v1] ArmPkg/ArmPlatformPkg CI enablement

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

Posted by PierreGondois 4 years, 9 months ago

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

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

Signed-off-by: Pierre Gondois <Pierre.Gondois@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 (#74330): https://edk2.groups.io/g/devel/message/74330
Mute This Topic: https://groups.io/mt/82258514/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

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

Posted by Sami Mujawar 4 years, 9 months ago

Hi Pierre,

Thank you for this patch.

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

Regards,

Sami Mujawar

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

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

Signed-off-by: Pierre Gondois <Pierre.Gondois@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/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

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

Posted by Bret Barkelew via groups.io 4 years, 9 months ago

Acked by: Bret Barkelew <bret.barkelew@microsoft.com>

- Bret

From: pierre.gondois@arm.com<mailto:pierre.gondois@arm.com>
Sent: Wednesday, April 21, 2021 5:21 AM
To: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; sami.mujawar@arm.com<mailto:Sami.Mujawar@arm.com>; leif@nuviainc.com<mailto:leif@nuviainc.com>; ardb+tianocore@kernel.org<mailto:ardb+tianocore@kernel.org>; Sean Brogan<mailto:sean.brogan@microsoft.com>; Bret Barkelew<mailto:Bret.Barkelew@microsoft.com>
Subject: [EXTERNAL] [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck

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

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

Signed-off-by: Pierre Gondois <Pierre.Gondois@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://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fstreetsidesoftware%2Fcspell&amp;data=04%7C01%7CBret.Barkelew%40microsoft.com%7Cd3baca9349a5434e411408d904bffb9b%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637546044883177478%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=r%2BsyJEm3F5LEoSXSJ8wvtklOlVbkHrkK7mQGh5qzxEs%3D&amp;reserved=0

+### 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 (#74431): https://edk2.groups.io/g/devel/message/74431
Mute This Topic: https://groups.io/mt/82389039/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-