Re: [edk2-devel] [PATCH v2 3/6] IntelFsp2Pkg: Add CI YAML file

["Michael Kubacki" <mikuback@linux.microsoft.com>]

+Other IntelFsp2Pkg & IntelFsp2WrapperPkg maintainers to To line

Please review the remaining patches in this patch series:

https://edk2.groups.io/g/devel/message/93859

Thanks,
Michael

On 10/3/2022 10:44 AM, Michael Kubacki wrote:
> Another reminder.
> 
> On 9/22/2022 9:07 PM, Michael Kubacki wrote:
>> Review reminder
>>
>> On 9/15/2022 3:41 PM, Michael Kubacki wrote:
>>> Hi Chasel,
>>>
>>> Your CI YAML file feedback in v1 is addressed now in v2.
>>>
>>> Can you please provide your review on this patch and [PATCH v2 5/6]?
>>>
>>> Note that I updated the commit message for this patch to remove the 
>>> info about the build being broken since that was recently fixed. That 
>>> update is in the branch:
>>>
>>> https://github.com/makubacki/edk2/commit/c37e6dfa482ed075cd4ab6712e6d17b3cf17786a 
>>>
>>>
>>> With these reviews, the series will be covered.
>>>
>>> Thanks,
>>> Michael
>>>
>>> On 9/15/2022 2:55 PM, Michael Kubacki wrote:
>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>
>>>> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=4048
>>>>
>>>> Adds IntelFsp2Pkg to the list of supported build packages for edk2
>>>> CI and defines an initial set of CI configuration options.
>>>>
>>>> The compiler plugin is disabled as the package currently does not
>>>> build due to some changes in the FSP 2.4 interface addition.
>>>>
>>>> Specifically, in commit df25a54 "Fsp24SecCore<API>.inf" files were
>>>> added to IntelFspPkg.dsc but the actual files were not added.
>>>>
>>>> Simply removing these files from the DSC exposes a linker failure.
>>>>
>>>> Recommendation:
>>>>
>>>> 1. Enable package CI (accept this change)
>>>> 2. Add IntelFsp2Pkg.dsc to the "CompilerPlugin" "DscPath" in
>>>>     IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml to enable compilation
>>>> 3. Verify compilation and all currently enabled package CI checks
>>>>     pass
>>>> 4. Check-in fixes in (3) with change in (2)
>>>>
>>>> Cc: Chasel Chiu <chasel.chiu@intel.com>
>>>> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
>>>> Cc: Star Zeng <star.zeng@intel.com>
>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>>> ---
>>>>   .pytool/CISettings.py             |  1 +
>>>>   IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml | 90 ++++++++++++++++++++
>>>>   2 files changed, 91 insertions(+)
>>>>
>>>> diff --git a/.pytool/CISettings.py b/.pytool/CISettings.py
>>>> index cf9e0d77b19b..0205c26a58f8 100644
>>>> --- a/.pytool/CISettings.py
>>>> +++ b/.pytool/CISettings.py
>>>> @@ -54,6 +54,7 @@ class Settings(CiBuildSettingsManager, 
>>>> UpdateSettingsManager, SetupSettingsManag
>>>>                   "ArmVirtPkg",
>>>>                   "DynamicTablesPkg",
>>>>                   "EmulatorPkg",
>>>> +                "IntelFsp2Pkg",
>>>>                   "MdePkg",
>>>>                   "MdeModulePkg",
>>>>                   "NetworkPkg",
>>>> diff --git a/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml 
>>>> b/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml
>>>> new file mode 100644
>>>> index 000000000000..9ce401b20164
>>>> --- /dev/null
>>>> +++ b/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml
>>>> @@ -0,0 +1,90 @@
>>>> +## @file
>>>> +# Core CI configuration for IntelFsp2Pkg
>>>> +#
>>>> +# Copyright (c) Microsoft Corporation
>>>> +#
>>>> +# SPDX-License-Identifier: BSD-2-Clause-Patent
>>>> +##
>>>> +{
>>>> +    ## options defined .pytool/Plugin/LicenseCheck
>>>> +    "LicenseCheck": {
>>>> +        "IgnoreFiles": []
>>>> +    },
>>>> +
>>>> +    "EccCheck": {
>>>> +        ## Exception sample looks like below:
>>>> +        ## "ExceptionList": [
>>>> +        ##     "<ErrorID>", "<KeyWord>"
>>>> +        ## ]
>>>> +        "ExceptionList": [
>>>> +        ],
>>>> +        ## Both file path and directory path are accepted.
>>>> +        "IgnoreFiles": []
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/CompilerPlugin
>>>> +    "CompilerPlugin": {
>>>> +        "DscPath": "IntelFsp2Pkg.dsc"
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
>>>> +    "HostUnitTestCompilerPlugin": {
>>>> +        "DscPath": "" # Don't support this test
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/CharEncodingCheck
>>>> +    "CharEncodingCheck": {
>>>> +        "IgnoreFiles": []
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/DependencyCheck
>>>> +    "DependencyCheck": {
>>>> +        "AcceptableDependencies": [
>>>> +          "IntelFsp2Pkg/IntelFsp2Pkg.dec",
>>>> +          "MdeModulePkg/MdeModulePkg.dec",
>>>> +          "MdePkg/MdePkg.dec",
>>>> +          "UefiCpuPkg/UefiCpuPkg.dec"
>>>> +        ],
>>>> +        # For host based unit tests
>>>> +        "AcceptableDependencies-HOST_APPLICATION":[
>>>> +          "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
>>>> +        ],
>>>> +        # For UEFI shell based apps
>>>> +        "AcceptableDependencies-UEFI_APPLICATION":[],
>>>> +        "IgnoreInf": []
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/DscCompleteCheck
>>>> +    "DscCompleteCheck": {
>>>> +        "IgnoreInf": [""],
>>>> +        "DscPath": "IntelFsp2Pkg.dsc"
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
>>>> +    "HostUnitTestDscCompleteCheck": {
>>>> +        "IgnoreInf": [""],
>>>> +        "DscPath": "" # Don't support this test
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/GuidCheck
>>>> +    "GuidCheck": {
>>>> +        "IgnoreGuidName": [],
>>>> +        "IgnoreGuidValue": [],
>>>> +        "IgnoreFoldersAndFiles": [],
>>>> +        "IgnoreDuplicates": [],
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/LibraryClassCheck
>>>> +    "LibraryClassCheck": {
>>>> +        "IgnoreHeaderFile": []
>>>> +    },
>>>> +
>>>> +    ## options defined .pytool/Plugin/SpellCheck
>>>> +    "SpellCheck": {
>>>> +        "AuditOnly": True,           # Fails right now with over 
>>>> 270 errors
>>>> +        "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)
>>>> +    }
>>>> +}