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