MdePkg/MdePkg.ci.yaml

   1 ## @file
   2 # CI configuration for MdePkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6 # Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
   7 # SPDX-License-Identifier: BSD-2-Clause-Patent
   8 ##
   9 {
  10     ## options defined .pytool/Plugin/LicenseCheck
  11     "LicenseCheck": {
  12         "IgnoreFiles": []
  13     },
  14     "EccCheck": {
  15         ## Exception sample looks like below:
  16         ## "ExceptionList": [
  17         ##     "<ErrorID>", "<KeyWord>"
  18         ## ]
  19         "ExceptionList": [
  20         ],
  21         ## Both file path and directory path are accepted.
  22         "IgnoreFiles": [
  23             "Include/IndustryStandard/Acpi64.h"
  24         ]
  25     },
  26     ## options defined ci/Plugin/CompilerPlugin
  27     "CompilerPlugin": {
  28         "DscPath": "MdePkg.dsc"
  29     },
  30
  31     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  32     "HostUnitTestCompilerPlugin": {
  33         "DscPath": "Test/MdePkgHostTest.dsc"
  34     },
  35
  36     ## options defined ci/Plugin/CharEncodingCheck
  37     "CharEncodingCheck": {
  38         "IgnoreFiles": []
  39     },
  40
  41     ## options defined ci/Plugin/DependencyCheck
  42     "DependencyCheck": {
  43         "AcceptableDependencies": [
  44             "MdePkg/MdePkg.dec"
  45         ],
  46         # For host based unit tests
  47         "AcceptableDependencies-HOST_APPLICATION":[
  48             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  49         ],
  50         # For UEFI shell based apps
  51         "AcceptableDependencies-UEFI_APPLICATION":[],
  52         "IgnoreInf": []
  53     },
  54
  55     ## options defined ci/Plugin/DscCompleteCheck
  56     "DscCompleteCheck": {
  57         "IgnoreInf": [""],
  58         "DscPath": "MdePkg.dsc"
  59     },
  60
  61     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
  62     "HostUnitTestDscCompleteCheck": {
  63         "IgnoreInf": [""],
  64         "DscPath": "Test/MdePkgHostTest.dsc"
  65     },
  66
  67     ## options defined ci/Plugin/GuidCheck
  68     "GuidCheck": {
  69         "IgnoreGuidName": [
  70             "gEfiFirmwareVolumeTopFileGuid" # sec modules must be set to this guid
  71         ],
  72         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
  73         "IgnoreFoldersAndFiles": [],
  74         "IgnoreDuplicates": [
  75             "gEfiFirmwareVolumeBlockProtocolGuid=gEfiFirmwareVolumeBlock2ProtocolGuid",
  76             "gEfiMmAccessProtocolGuid=gEfiSmmAccess2ProtocolGuid",
  77             "gEfiSmmCommunicationProtocolGuid=gEfiMmCommunicationProtocolGuid",
  78             "gEfiMmPciRootBridgeIoProtocolGuid=gEfiSmmPciRootBridgeIoProtocolGuid",
  79             "gEfiTrEEProtocolGuid=gEfiTcg2ProtocolGuid",
  80             "gEfiSmmPowerButtonDispatch2ProtocolGuid=gEfiMmPowerButtonDispatchProtocolGuid",
  81             "gEfiSmmBase2ProtocolGuid=gEfiMmBaseProtocolGuid",
  82             "gEfiSmmUsbDispatch2ProtocolGuid=gEfiMmUsbDispatchProtocolGuid",
  83             "gEfiSmmCpuProtocolGuid=gEfiMmCpuProtocolGuid",
  84             "gEfiAcpiTableGuid=gEfiAcpi20TableGuid",
  85             "gEfiSmmControl2ProtocolGuid=gEfiMmControlProtocolGuid",
  86             "gEfiSmmStandbyButtonDispatch2ProtocolGuid=gEfiMmStandbyButtonDispatchProtocolGuid",
  87             "gEfiSmmStatusCodeProtocolGuid=gEfiMmStatusCodeProtocolGuid",
  88             "gEfiDxeSmmReadyToLockProtocolGuid=gEfiDxeMmReadyToLockProtocolGuid",
  89             "gEfiSmmIoTrapDispatch2ProtocolGuid=gEfiMmIoTrapDispatchProtocolGuid",
  90             "gEfiSmmReadyToLockProtocolGuid=gEfiMmReadyToLockProtocolGuid",
  91             "gEfiSmmSxDispatch2ProtocolGuid=gEfiMmSxDispatchProtocolGuid",
  92             "gEfiPeiCapsulePpiGuid=gPeiCapsulePpiGuid",
  93             "gEfiSmmCpuIo2ProtocolGuid=gEfiMmCpuIoProtocolGuid",
  94             "gEfiSmmRscHandlerProtocolGuid=gEfiMmRscHandlerProtocolGuid",
  95             "gEfiSmmConfigurationProtocolGuid=gEfiMmConfigurationProtocolGuid",
  96             "gEfiSmmGpiDispatch2ProtocolGuid=gEfiMmGpiDispatchProtocolGuid",
  97             "gEfiSmmEndOfDxeProtocolGuid=gEfiMmEndOfDxeProtocolGuid",
  98             "gEfiSmmSwDispatch2ProtocolGuid=gEfiMmSwDispatchProtocolGuid",
  99             "gEfiDebugPortProtocolGuid=gEfiDebugPortVariableGuid=gEfiDebugPortDevicePathGuid", ## is this a bug
 100             "gEfiProcessorSpecificErrorSectionGuid=gEfiIa32X64ProcessorErrorSectionGuid",  ## is this a bug
 101             "gEfiSmmPeriodicTimerDispatch2ProtocolGuid=gEfiMmPeriodicTimerDispatchProtocolGuid",
 102             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
 103             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid"
 104             ]
 105     },
 106
 107     ## options defined ci/Plugin/LibraryClassCheck
 108     "LibraryClassCheck": {
 109         "IgnoreHeaderFile": []
 110     },
 111
 112     ## options defined ci/Plugin/SpellCheck
 113     "SpellCheck": {
 114         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
 115         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
 116         "ExtendWords": [],           # words to extend to the dictionary for this package
 117         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
 118         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
 119     }
 120 }