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.9872.1619537599869590181 for ; Tue, 27 Apr 2021 08:33:20 -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 83049ED1; Tue, 27 Apr 2021 08:33:19 -0700 (PDT) Received: from e120189.arm.com (unknown [10.57.3.114]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 13C133F73B; Tue, 27 Apr 2021 08:33:17 -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 v2 13/15] .pytool: Document LicenseCheck and EccCheck Date: Tue, 27 Apr 2021 16:32:49 +0100 Message-Id: <20210427153251.11576-14-Pierre.Gondois@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210427153251.11576-1-Pierre.Gondois@arm.com> References: <20210427153251.11576-1-Pierre.Gondois@arm.com> From: Pierre Gondois Add an entry in the documentation for the LicenseCheck and EccCheck plugins. Cc: Bret Barkelew Cc: Sean Brogan Cc: Leif Lindholm Cc: Ard Biesheuvel Cc: Sami Mujawar Signed-off-by: Pierre Gondois Acked-by: Bret Barkelew Reviewed-by: Sami Mujawar --- .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