MdeModulePkg/MdeModulePkg.ci.yaml

   1 ## @file
   2 # CI configuration for MdeModulePkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP<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             "8005", "UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE.UID",
  21             "8005", "UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE.HID",
  22             "8001", "UefiSortLibUnitTestMain",
  23         ],
  24         ## Both file path and directory path are accepted.
  25         "IgnoreFiles": [
  26             "Library/LzmaCustomDecompressLib",
  27             "Library/BrotliCustomDecompressLib",
  28             "Universal/RegularExpressionDxe"
  29         ]
  30     },
  31     ## options defined ci/Plugin/CompilerPlugin
  32     "CompilerPlugin": {
  33         "DscPath": "MdeModulePkg.dsc"
  34     },
  35     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  36     "HostUnitTestCompilerPlugin": {
  37         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  38     },
  39
  40     ## options defined ci/Plugin/CharEncodingCheck
  41     "CharEncodingCheck": {
  42         "IgnoreFiles": [
  43             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",
  44             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/testc.c"
  45         ]
  46     },
  47
  48     ## options defined ci/Plugin/DependencyCheck
  49     "DependencyCheck": {
  50         "AcceptableDependencies": [
  51             "MdePkg/MdePkg.dec",
  52             "MdeModulePkg/MdeModulePkg.dec",
  53             "StandaloneMmPkg/StandaloneMmPkg.dec",
  54             "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an abstraction
  55         ],
  56         # For host based unit tests
  57         "AcceptableDependencies-HOST_APPLICATION":[
  58             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  59         ],
  60         # For UEFI shell based apps
  61         "AcceptableDependencies-UEFI_APPLICATION":[],
  62         "IgnoreInf": []
  63     },
  64
  65     ## options defined ci/Plugin/DscCompleteCheck
  66     "DscCompleteCheck": {
  67         "IgnoreInf": [],
  68         "DscPath": "MdeModulePkg.dsc"
  69     },
  70     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
  71     "HostUnitTestDscCompleteCheck": {
  72         "IgnoreInf": [""],
  73         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  74     },
  75
  76     ## options defined ci/Plugin/GuidCheck
  77     "GuidCheck": {
  78         "IgnoreGuidName": [],
  79         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
  80         "IgnoreFoldersAndFiles": [],
  81         "IgnoreDuplicates": [
  82             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
  83             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
  84             "gEfiPeiMmCommunicationPpiGuid=gEfiPeiSmmCommunicationPpiGuid",
  85         ]
  86     },
  87
  88     ## options defined ci/Plugin/LibraryClassCheck
  89     "LibraryClassCheck": {
  90         "IgnoreHeaderFile": []
  91     },
  92
  93     ## options defined ci/Plugin/SpellCheck
  94     "SpellCheck": {
  95         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  96         "IgnoreStandardPaths": [     # Standard Plugin defined paths that should be ignore
  97             "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"
  98         ],
  99         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
 100             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
 101         ],
 102         "ExtendWords": [           # words to extend to the dictionary for this package
 103             "LIGHTGRAY",
 104             "DARKGRAY",
 105             "LIGHTBLUE",
 106             "LIGHTGREEN",
 107             "LIGHTCYAN",
 108             "LIGHTRED",
 109             "LIGHTMAGENTA",
 110             "FVMAIN",
 111             "VARCHECKPCD",
 112             "Getxx",
 113             "lzturbo",
 114             "musthave",
 115             "canthave"
 116         ],
 117         "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)
 118     }
 119 }