1. Patchew
  2. EDK2
  3. [edk2-devel] [PATCH 00/15] Add a plugin LicenseCheck in open ci
  4. View patch

[edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck

Zhang, Shenglei posted 15 patches 5 years, 6 months ago
There is a newer version of this series
[edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Zhang, Shenglei 5 years, 6 months ago 
Add configuration IgnoreFiles for package config files.
So users can rely on this to skip license conflict for
some generated files.

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 OvmfPkg/OvmfPkg.ci.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
index 98992f0429ff..ed342d7a3d08 100644
--- a/OvmfPkg/OvmfPkg.ci.yaml
+++ b/OvmfPkg/OvmfPkg.ci.yaml
@@ -8,6 +8,10 @@
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 ##
 {
+    ## options defined .pytool/Plugin/LicenseCheck
+    "LicenseCheck": {
+        "IgnoreFiles": []
+    },
     ## options defined .pytool/Plugin/CompilerPlugin
     "CompilerPlugin": {
         "DscPath": "" # Don't support this test
-- 
2.18.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62816): https://edk2.groups.io/g/devel/message/62816
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Laszlo Ersek 5 years, 6 months ago 
On 07/20/20 10:37, Shenglei Zhang wrote:
> Add configuration IgnoreFiles for package config files.
> So users can rely on this to skip license conflict for
> some generated files.
> 
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
> Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
> ---
>  OvmfPkg/OvmfPkg.ci.yaml | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
> index 98992f0429ff..ed342d7a3d08 100644
> --- a/OvmfPkg/OvmfPkg.ci.yaml
> +++ b/OvmfPkg/OvmfPkg.ci.yaml
> @@ -8,6 +8,10 @@
>  # SPDX-License-Identifier: BSD-2-Clause-Patent
>  ##
>  {
> +    ## options defined .pytool/Plugin/LicenseCheck
> +    "LicenseCheck": {
> +        "IgnoreFiles": []
> +    },
>      ## options defined .pytool/Plugin/CompilerPlugin
>      "CompilerPlugin": {
>          "DscPath": "" # Don't support this test
> 

Can you list the following file at once, please:

  OvmfPkg/QemuVideoDxe/VbeShim.h

With that:

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Thanks
Laszlo


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62873): https://edk2.groups.io/g/devel/message/62873
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Zhang, Shenglei 5 years, 6 months ago 
Hi Laszlo,

VbeShim.h is existing in edk2 now. This plugin only checks the patches to be checked in.
So there's no need to add existing files to this section.

Thanks,
Shenglei

> -----Original Message-----
> From: Laszlo Ersek <lersek@redhat.com>
> Sent: Tuesday, July 21, 2020 6:01 AM
> To: Zhang, Shenglei <shenglei.zhang@intel.com>; devel@edk2.groups.io
> Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Ard Biesheuvel
> <ard.biesheuvel@arm.com>
> Subject: Re: [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for
> LicenseCheck
> 
> On 07/20/20 10:37, Shenglei Zhang wrote:
> > Add configuration IgnoreFiles for package config files.
> > So users can rely on this to skip license conflict for
> > some generated files.
> >
> > Cc: Jordan Justen <jordan.l.justen@intel.com>
> > Cc: Laszlo Ersek <lersek@redhat.com>
> > Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
> > Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
> > ---
> >  OvmfPkg/OvmfPkg.ci.yaml | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
> > index 98992f0429ff..ed342d7a3d08 100644
> > --- a/OvmfPkg/OvmfPkg.ci.yaml
> > +++ b/OvmfPkg/OvmfPkg.ci.yaml
> > @@ -8,6 +8,10 @@
> >  # SPDX-License-Identifier: BSD-2-Clause-Patent
> >  ##
> >  {
> > +    ## options defined .pytool/Plugin/LicenseCheck
> > +    "LicenseCheck": {
> > +        "IgnoreFiles": []
> > +    },
> >      ## options defined .pytool/Plugin/CompilerPlugin
> >      "CompilerPlugin": {
> >          "DscPath": "" # Don't support this test
> >
> 
> Can you list the following file at once, please:
> 
>   OvmfPkg/QemuVideoDxe/VbeShim.h
> 
> With that:
> 
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> 
> Thanks
> Laszlo


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#63285): https://edk2.groups.io/g/devel/message/63285
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Laszlo Ersek 5 years, 6 months ago 
On 07/27/20 08:21, Zhang, Shenglei wrote:
> Hi Laszlo,
> 
> VbeShim.h is existing in edk2 now. This plugin only checks the patches to be checked in.
> So there's no need to add existing files to this section.

OK, thanks, we can always extend this stanza later, if needed.

Rebecca: once this patch is upstream, please post a separate patch for listing "OvmfPkg/Bhyve/BhyveRfbDxe/VbeShim.h" in "IgnoreFiles". Otherwise I won't be able to merge your patch at <https://edk2.groups.io/g/devel/message/62395>.


Shenglei: I have a question regarding IgnoreFiles syntax. In "MdeModulePkg/MdeModulePkg.ci.yaml", there are two syntaxes:

- The IgnoreFiles stanza for "CharEncodingCheck" uses pathnames that are relative to the *project* root:

>     ## options defined ci/Plugin/CharEncodingCheck
>     "CharEncodingCheck": {
>         "IgnoreFiles": [
>             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",
>             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/testc.c"
>         ]
>     },

- The IgnoreFiles stanza for "SpellCheck" uses pathnames that are relative to the *package* (not project) root:

>     "SpellCheck": {
> ...
>         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
>             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
>         ],

How do we know whether a particular check's IgnoreFiles stanza requires project-root-relative or package-root-relative pathnames?

Thanks!
Laszlo

> Thanks,
> Shenglei
> 
>> -----Original Message-----
>> From: Laszlo Ersek <lersek@redhat.com>
>> Sent: Tuesday, July 21, 2020 6:01 AM
>> To: Zhang, Shenglei <shenglei.zhang@intel.com>; devel@edk2.groups.io
>> Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Ard Biesheuvel
>> <ard.biesheuvel@arm.com>
>> Subject: Re: [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for
>> LicenseCheck
>>
>> On 07/20/20 10:37, Shenglei Zhang wrote:
>>> Add configuration IgnoreFiles for package config files.
>>> So users can rely on this to skip license conflict for
>>> some generated files.
>>>
>>> Cc: Jordan Justen <jordan.l.justen@intel.com>
>>> Cc: Laszlo Ersek <lersek@redhat.com>
>>> Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
>>> Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
>>> ---
>>>  OvmfPkg/OvmfPkg.ci.yaml | 4 ++++
>>>  1 file changed, 4 insertions(+)
>>>
>>> diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
>>> index 98992f0429ff..ed342d7a3d08 100644
>>> --- a/OvmfPkg/OvmfPkg.ci.yaml
>>> +++ b/OvmfPkg/OvmfPkg.ci.yaml
>>> @@ -8,6 +8,10 @@
>>>  # SPDX-License-Identifier: BSD-2-Clause-Patent
>>>  ##
>>>  {
>>> +    ## options defined .pytool/Plugin/LicenseCheck
>>> +    "LicenseCheck": {
>>> +        "IgnoreFiles": []
>>> +    },
>>>      ## options defined .pytool/Plugin/CompilerPlugin
>>>      "CompilerPlugin": {
>>>          "DscPath": "" # Don't support this test
>>>
>>
>> Can you list the following file at once, please:
>>
>>   OvmfPkg/QemuVideoDxe/VbeShim.h
>>
>> With that:
>>
>> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
>>
>> Thanks
>> Laszlo
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#63296): https://edk2.groups.io/g/devel/message/63296
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Zhang, Shenglei 5 years, 6 months ago 
Hi Laszlo,

> -----Original Message-----
> From: Laszlo Ersek <lersek@redhat.com>
> Sent: Monday, July 27, 2020 5:51 PM
> To: Zhang, Shenglei <shenglei.zhang@intel.com>; Rebecca Cran
> <rebecca@bsdio.com>
> Cc: devel@edk2.groups.io; Justen, Jordan L <jordan.l.justen@intel.com>;
> Ard Biesheuvel <ard.biesheuvel@arm.com>
> Subject: Re: [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for
> LicenseCheck
> 
> On 07/27/20 08:21, Zhang, Shenglei wrote:
> > Hi Laszlo,
> >
> > VbeShim.h is existing in edk2 now. This plugin only checks the patches to
> be checked in.
> > So there's no need to add existing files to this section.
> 
> OK, thanks, we can always extend this stanza later, if needed.
> 
> Rebecca: once this patch is upstream, please post a separate patch for listing
> "OvmfPkg/Bhyve/BhyveRfbDxe/VbeShim.h" in "IgnoreFiles". Otherwise I
> won't be able to merge your patch at
> <https://edk2.groups.io/g/devel/message/62395>.
> 
> 
> Shenglei: I have a question regarding IgnoreFiles syntax. In
> "MdeModulePkg/MdeModulePkg.ci.yaml", there are two syntaxes:
> 
> - The IgnoreFiles stanza for "CharEncodingCheck" uses pathnames that are
> relative to the *project* root:
> 
> >     ## options defined ci/Plugin/CharEncodingCheck
> >     "CharEncodingCheck": {
> >         "IgnoreFiles": [
> >
> "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",
> >
> "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/tes
> tc.c"
> >         ]
> >     },
> 
> - The IgnoreFiles stanza for "SpellCheck" uses pathnames that are relative to
> the *package* (not project) root:
> 
> >     "SpellCheck": {
> > ...
> >         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching
> files
> >             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
> >         ],
> 
> How do we know whether a particular check's IgnoreFiles stanza requires
> project-root-relative or package-root-relative pathnames?

It depends on the designing of the plugins, likes the check scope.
But looks like all checks' IgnoreFiles stanza only requires package-root-relative pathnames, currently.
It's recommended to use package-root-relative pathnames because a plugin must support this format.

Thanks,
Shenglei

> 
> Thanks!
> Laszlo
> 
> > Thanks,
> > Shenglei
> >
> >> -----Original Message-----
> >> From: Laszlo Ersek <lersek@redhat.com>
> >> Sent: Tuesday, July 21, 2020 6:01 AM
> >> To: Zhang, Shenglei <shenglei.zhang@intel.com>; devel@edk2.groups.io
> >> Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Ard Biesheuvel
> >> <ard.biesheuvel@arm.com>
> >> Subject: Re: [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration
> for
> >> LicenseCheck
> >>
> >> On 07/20/20 10:37, Shenglei Zhang wrote:
> >>> Add configuration IgnoreFiles for package config files.
> >>> So users can rely on this to skip license conflict for
> >>> some generated files.
> >>>
> >>> Cc: Jordan Justen <jordan.l.justen@intel.com>
> >>> Cc: Laszlo Ersek <lersek@redhat.com>
> >>> Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
> >>> Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
> >>> ---
> >>>  OvmfPkg/OvmfPkg.ci.yaml | 4 ++++
> >>>  1 file changed, 4 insertions(+)
> >>>
> >>> diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
> >>> index 98992f0429ff..ed342d7a3d08 100644
> >>> --- a/OvmfPkg/OvmfPkg.ci.yaml
> >>> +++ b/OvmfPkg/OvmfPkg.ci.yaml
> >>> @@ -8,6 +8,10 @@
> >>>  # SPDX-License-Identifier: BSD-2-Clause-Patent
> >>>  ##
> >>>  {
> >>> +    ## options defined .pytool/Plugin/LicenseCheck
> >>> +    "LicenseCheck": {
> >>> +        "IgnoreFiles": []
> >>> +    },
> >>>      ## options defined .pytool/Plugin/CompilerPlugin
> >>>      "CompilerPlugin": {
> >>>          "DscPath": "" # Don't support this test
> >>>
> >>
> >> Can you list the following file at once, please:
> >>
> >>   OvmfPkg/QemuVideoDxe/VbeShim.h
> >>
> >> With that:
> >>
> >> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> >>
> >> Thanks
> >> Laszlo
> >


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#63366): https://edk2.groups.io/g/devel/message/63366
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for LicenseCheck
Posted by Laszlo Ersek 5 years, 6 months ago 
On 07/28/20 03:11, Zhang, Shenglei wrote:
> Hi Laszlo,
> 
>> -----Original Message-----
>> From: Laszlo Ersek <lersek@redhat.com>
>> Sent: Monday, July 27, 2020 5:51 PM
>> To: Zhang, Shenglei <shenglei.zhang@intel.com>; Rebecca Cran
>> <rebecca@bsdio.com>
>> Cc: devel@edk2.groups.io; Justen, Jordan L <jordan.l.justen@intel.com>;
>> Ard Biesheuvel <ard.biesheuvel@arm.com>
>> Subject: Re: [PATCH 10/15] OvmfPkg/OvmfPkg.ci.yaml: Add configuration for
>> LicenseCheck
>>
>> On 07/27/20 08:21, Zhang, Shenglei wrote:
>>> Hi Laszlo,
>>>
>>> VbeShim.h is existing in edk2 now. This plugin only checks the patches to
>> be checked in.
>>> So there's no need to add existing files to this section.
>>
>> OK, thanks, we can always extend this stanza later, if needed.
>>
>> Rebecca: once this patch is upstream, please post a separate patch for listing
>> "OvmfPkg/Bhyve/BhyveRfbDxe/VbeShim.h" in "IgnoreFiles". Otherwise I
>> won't be able to merge your patch at
>> <https://edk2.groups.io/g/devel/message/62395>.
>>
>>
>> Shenglei: I have a question regarding IgnoreFiles syntax. In
>> "MdeModulePkg/MdeModulePkg.ci.yaml", there are two syntaxes:
>>
>> - The IgnoreFiles stanza for "CharEncodingCheck" uses pathnames that are
>> relative to the *project* root:
>>
>>>     ## options defined ci/Plugin/CharEncodingCheck
>>>     "CharEncodingCheck": {
>>>         "IgnoreFiles": [
>>>
>> "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",
>>>
>> "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/tes
>> tc.c"
>>>         ]
>>>     },
>>
>> - The IgnoreFiles stanza for "SpellCheck" uses pathnames that are relative to
>> the *package* (not project) root:
>>
>>>     "SpellCheck": {
>>> ...
>>>         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching
>> files
>>>             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
>>>         ],
>>
>> How do we know whether a particular check's IgnoreFiles stanza requires
>> project-root-relative or package-root-relative pathnames?
> 
> It depends on the designing of the plugins, likes the check scope.
> But looks like all checks' IgnoreFiles stanza only requires package-root-relative pathnames, currently.
> It's recommended to use package-root-relative pathnames because a plugin must support this format.

Thanks!

So we should ignore "Bhyve/BhyveRfbDxe/VbeShim.h".

Thanks
Laszlo


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#63397): https://edk2.groups.io/g/devel/message/63397
Mute This Topic: https://groups.io/mt/75678218/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.