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

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

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