From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web09.11344.1619007685591560386 for ; Wed, 21 Apr 2021 05:21:25 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: pierre.gondois@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 4574C1063; Wed, 21 Apr 2021 05:21:25 -0700 (PDT) Received: from e120189.arm.com (unknown [10.57.26.208]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id E3CF73F694; Wed, 21 Apr 2021 05:21:23 -0700 (PDT) From: "PierreGondois" To: devel@edk2.groups.io, sami.mujawar@arm.com, leif@nuviainc.com, ardb+tianocore@kernel.org, sean.brogan@microsoft.com, Bret.Barkelew@microsoft.com Subject: [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck Date: Wed, 21 Apr 2021 13:20:46 +0100 Message-Id: <20210421122048.11729-11-Pierre.Gondois@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210421122048.11729-1-Pierre.Gondois@arm.com> References: <20210421122048.11729-1-Pierre.Gondois@arm.com> From: Pierre Gondois Add an entry in the documentation for the LicenseCheck and EccCheck plugins. Signed-off-by: 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