public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "PierreGondois" <pierre.gondois@arm.com>
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	[thread overview]
Message-ID: <20210421122048.11729-11-Pierre.Gondois@arm.com> (raw)
In-Reply-To: <20210421122048.11729-1-Pierre.Gondois@arm.com>

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


  parent reply	other threads:[~2021-04-21 12:21 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-21 12:20 [PATCH v1 00/12] ArmPkg/ArmPlatformPkg CI enablement PierreGondois
2021-04-21 12:20 ` [PATCH v1 01/12] ArmPkg: Fix Ecc error 8003 PierreGondois
2021-04-22  9:40   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 02/12] ArmPkg: Fix Ecc error 3002 in StandaloneMmMmuLib PierreGondois
2021-04-22  9:40   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec PierreGondois
2021-04-21 19:13   ` [edk2-devel] " brbarkel
2021-04-26 16:40     ` PierreGondois
2021-04-26 20:58       ` [EXTERNAL] " Bret Barkelew
2021-04-22  9:51   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 04/12] ArmPkg: Add OemMiscLibNull library to ArmPkg.dsc PierreGondois
2021-04-21 19:14   ` [edk2-devel] " brbarkel
2021-04-22  9:52   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 05/12] ArmPkg: Correct small typos PierreGondois
2021-04-22  9:53   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 06/12] ArmPkg: Add ArmPkg.ci.yaml PierreGondois
2021-04-22 10:02   ` Sami Mujawar
2021-04-27 14:30     ` PierreGondois
2021-04-21 12:20 ` [PATCH v1 07/12] ArmPlatformPkg: Add ArmPlatformPkg.ci.yaml PierreGondois
2021-04-22 10:05   ` Sami Mujawar
2021-04-21 12:20 ` [PATCH v1 08/12] .pytool: Enable CI for ArmPkg PierreGondois
2021-04-22 10:07   ` Sami Mujawar
2021-04-26 20:54   ` [EXTERNAL] " Bret Barkelew
2021-04-21 12:20 ` [PATCH v1 09/12] .pytool: Enable CI for ArmPlatformPkg PierreGondois
2021-04-22 10:07   ` Sami Mujawar
2021-04-26 20:55   ` [EXTERNAL] " Bret Barkelew
2021-04-21 12:20 ` PierreGondois [this message]
2021-04-22 10:08   ` [PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck Sami Mujawar
2021-04-26 20:56   ` [EXTERNAL] " Bret Barkelew
2021-04-21 12:20 ` [PATCH v1 11/12] AzurePipelines: Add support for ArmPkg PierreGondois
2021-04-22 10:09   ` Sami Mujawar
2021-04-26 20:58   ` [EXTERNAL] " Bret Barkelew
2021-04-21 12:20 ` [PATCH v1 12/12] AzurePipelines: Add support for ArmPlatformPkg PierreGondois
2021-04-22 10:09   ` Sami Mujawar
2021-04-26 20:57   ` [EXTERNAL] " Bret Barkelew

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210421122048.11729-11-Pierre.Gondois@arm.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox