Re: [edk2-devel] [Patch v4 17/22] UefiCpuPkg: Add YAML file for CI builds

["Laszlo Ersek" <lersek@redhat.com>]

On 11/07/19 20:33, Sean Brogan wrote:
> Laszlo,
> 
> Our legal team has requested that we don't include the copyright year. 

This sounds unusual, per

  https://en.wikipedia.org/wiki/Copyright_notice#Technical_requirements

and also per

https://edk2-docs.gitbooks.io/edk-ii-c-coding-standards-specification/5_source_files/54_code_file_structure.html

(note "Copyright (c) 20XX, Acme Corporation").

But, obviously, I'm not a lawyer, and your legal team consists of
lawyers :) So if they prefer this format, my only remaining request is
that this preference please be pointed out in the commit message:

"the copyright notice(s) in the new file(s) do not contain a copyright
year on purpose"

The reason I'm asking for this is that "no copyright year" is unusual
enough in edk2 that it deserves a comment ("it's not an oversight").

Thanks!
Laszlo

> -----Original Message-----
> From: Kinney, Michael D <michael.d.kinney@intel.com> 
> Sent: Thursday, November 7, 2019 11:23 AM
> To: devel@edk2.groups.io; lersek@redhat.com; Sean Brogan <sean.brogan@microsoft.com>
> Cc: Dong, Eric <eric.dong@intel.com>; Ni, Ray <ray.ni@intel.com>
> Subject: RE: [edk2-devel] [Patch v4 17/22] UefiCpuPkg: Add YAML file for CI builds
> 
> Hi Laszlo,
> 
> I will let Sean comment on the copyright line contents.
> 
> Mike
> 
>> -----Original Message-----
>> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Laszlo 
>> Ersek
>> Sent: Thursday, November 7, 2019 2:48 AM
>> To: Kinney, Michael D <michael.d.kinney@intel.com>; 
>> devel@edk2.groups.io
>> Cc: Dong, Eric <eric.dong@intel.com>; Ni, Ray <ray.ni@intel.com>
>> Subject: Re: [edk2-devel] [Patch v4 17/22] UefiCpuPkg:
>> Add YAML file for CI builds
>>
>> On 11/07/19 11:42, Laszlo Ersek wrote:
>>> On 11/07/19 02:13, Michael D Kinney wrote:
>>>> Add YAML file to the package directory with the
>> configuration of the
>>>> checks to perform during a CI build.
>>>>
>>>> Cc: Eric Dong <eric.dong@intel.com>
>>>> Cc: Ray Ni <ray.ni@intel.com>
>>>> Cc: Laszlo Ersek <lersek@redhat.com>
>>>> Signed-off-by: Michael D Kinney
>> <michael.d.kinney@intel.com>
>>>> Acked-by: Laszlo Ersek <lersek@redhat.com>
>>>> ---
>>>>  UefiCpuPkg/UefiCpuPkg.ci.yaml | 51
>>>> +++++++++++++++++++++++++++++++++++
>>>>  1 file changed, 51 insertions(+)
>>>>  create mode 100644 UefiCpuPkg/UefiCpuPkg.ci.yaml
>>>>
>>>> diff --git a/UefiCpuPkg/UefiCpuPkg.ci.yaml 
>>>> b/UefiCpuPkg/UefiCpuPkg.ci.yaml new file mode 100644
>> index
>>>> 0000000000..81da29b878
>>>> --- /dev/null
>>>> +++ b/UefiCpuPkg/UefiCpuPkg.ci.yaml
>>>> @@ -0,0 +1,51 @@
>>>> +##
>>>> +# CI configuration for UefiCpuPkg
>>>> +#
>>>> +# Copyright (c) Microsoft Corporation # SPDX-
>> License-Identifier:
>>>> +BSD-2-Clause-Patent ## {
>>>> +    "CompilerPlugin": {
>>>> +        "DscPath": "UefiCpuPkg.dsc"
>>>> +    },
>>>> +    "CharEncodingCheck": {
>>>> +        "IgnoreFiles": []
>>>> +    },
>>>> +    "DependencyCheck": {
>>>> +        "AcceptableDependencies": [
>>>> +            "MdePkg/MdePkg.dec",
>>>> +            "MdeModulePkg/MdeModulePkg.dec",
>>>> +            "UefiCpuPkg/UefiCpuPkg.dec"
>>>> +        ],
>>>> +        # For host based unit tests
>>>> +        "AcceptableDependencies-
>> HOST_APPLICATION":[],
>>>> +        # For UEFI shell based apps
>>>> +        "AcceptableDependencies-
>> UEFI_APPLICATION":[],
>>>> +        "IgnoreInf": []
>>>> +    },
>>>> +    "DscCompleteCheck": {
>>>> +        "DscPath": "UefiCpuPkg.dsc",
>>>> +        "IgnoreInf": [
>>>> +
>> "UefiCpuPkg/ResetVector/FixupVtf/Vtf.inf",
>>>> +            "UefiCpuPkg/ResetVector/Vtf0/Vtf0.inf"
>>>> +        ]
>>>> +    },
>>>> +    "GuidCheck": {
>>>> +        "IgnoreGuidName": ["SecCore",
>> "ResetVector"], # Expected duplication for 
>> gEfiFirmwareVolumeTopFileGuid
>>>> +        "IgnoreGuidValue": [],
>>>> +        "IgnoreFoldersAndFiles": [],
>>>> +        "IgnoreDuplicates": []
>>>> +    },
>>>> +    "LibraryClassCheck": {
>>>> +        "IgnoreHeaderFile": []
>>>> +    },
>>>> +
>>>> +    ## options defined ci/Plugin/SpellCheck
>>>> +    "SpellCheck": {
>>>> +        "AuditOnly": True,           # Fails test
>> but run in AuditOnly mode to collect log
>>>> +        "IgnoreFiles": [],           # use gitignore
>> syntax to ignore errors in matching files
>>>> +        "ExtendWords": [],           # words to
>> extend to the dictionary for this package
>>>> +        "IgnoreStandardPaths": [],   # Standard
>> Plugin defined paths that should be ignore
>>>> +        "AdditionalIncludePaths": [] # Additional
>> paths to spell check (wildcards supported)
>>>> +    }
>>>> +}
>>>>
>>>
>>> This is a very nice patch: good commit message (subjet
>> and body both),
>>> and good file comment.
>>>
>>> One suggestion: I'd recommend adding "@file" to the
>> comment block at
>>> the top.
>>>
>>> With that:
>>>
>>> Acked-by: Laszlo Ersek <lersek@redhat.com>
>>>
>>> (Of course, should "@file" confuse the YAML parser,
>> then I won't
>>> insist, and my ACK still applies.)
>>
>> Ah, another remark: I believe the copyright notice should state a 
>> year.
>> (Most likely "2019".)
>>
>> Thanks
>> Laszlo
>>
>>
>> 
>