MdePkg/MdePkg.ci.yaml

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