Re: [edk2-devel] [PATCH 00/15] Add a plugin LicenseCheck in open ci

["Liming Gao" <liming.gao@intel.com>]

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Andrew Fish via groups.io
Sent: 2020年7月29日 23:22
To: edk2-devel-groups-io <devel@edk2.groups.io>; Laszlo Ersek <lersek@redhat.com>
Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>; Zhang, Shenglei <shenglei.zhang@intel.com>; Sean Brogan <sean.brogan@microsoft.com>; Bret Barkelew <Bret.Barkelew@microsoft.com>; Dong, Eric <eric.dong@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Chao Zhang <chao.b.zhang@intel.com>; Justen, Jordan L <jordan.l.justen@intel.com>; Maciej Rabeda <maciej.rabeda@linux.intel.com>; Wu, Jiaxin <jiaxin.wu@intel.com>; Fu, Siyuan <siyuan.fu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Wu, Hao A <hao.a.wu@intel.com>; Ni, Ray <ray.ni@intel.com>; Lu, XiaoyuX <xiaoyux.lu@intel.com>; Ard Biesheuvel <ard.biesheuvel@arm.com>; Leif Lindholm <leif@nuviainc.com>
Subject: Re: [edk2-devel] [PATCH 00/15] Add a plugin LicenseCheck in open ci



> On Jul 29, 2020, at 2:21 AM, Laszlo Ersek <lersek@redhat.com> wrote:
> 
> On 07/29/20 03:32, Kinney, Michael D wrote:
>> Hi Liming,
>> 
>> There are exception to PatchCheck as well for line endings and tabs.
>> 
>> Seems like a similar problem, and a single CI plugin could support 
>> all these cases.
> 
> The exceptions for LicenseCheck are individual files that package 
> maintainers (and contributors too) could customize. The primary use 
> case is permitting generated files to have no SPDX tag at all. 
> PatchCheck does not have a customizable exception list; it only 
> considers general rules that apply to the whole tree.
> 
> I did suggest "@file: generated" as a general marker for generated 
> files (which would opt them out of SPDX enforcement), here:
> <https://bugzilla.tianocore.org/show_bug.cgi?id=2833#c1>.
> 

This sounds like a good plan for any file generated by the edk2.

[Liming] I agree this is a good suggestion. This requires all generated files to follow this rule. 
The first step is to enable LicenseCheck plugin (the patch has passed review and ready for merge, https://edk2.groups.io/g/devel/message/63447). 
Then, package maintainers can add the exception files. Next, we can continue to enhance LicenseCheck. 

Thanks
Liming

Thanks,

Andrew Fish

> I'm equally happy with an IgnoreFiles stanza in 
> "OvmfPkg/OvmfPkg.ci.yaml", or a marker like "@file: generated" in some 
> files under OvmfPkg. What's important to me is that we can control and 
> update the license checks for OvmfPkg/ files with OvmfPkg/ patches. 
> That is, in case we need to tweak the license check for some OvmfPkg/ 
> file, the corresponding patch should need OvmfPkg maintainer approval *only*.
> Adding exceptions to PatchCheck has been difficult, as (a) it affects 
> all of edk2, (b) technically it needs to pass BaseTools review.
> 
> With the license check, I'm happy to have the mechanism under 
> BaseTools and/or CI, but the policy should be per package. Again my 
> sole motivation at this time is generated files that we need to check 
> in for whatever reason.
> 
> Thanks!
> Laszlo
> 
> 
> 
>