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 # SPDX-License-Identifier: BSD-2-Clause-Patent
   7 ##
   8 {
   9     ## options defined .pytool/Plugin/LicenseCheck
  10     "LicenseCheck": {
  11         "IgnoreFiles": []
  12     },
  13     "EccCheck": {
  14         ## Exception sample looks like below:
  15         ## "ExceptionList": [
  16         ##     "<ErrorID>", "<KeyWord>"
  17         ## ]
  18         "ExceptionList": [
  19         ],
  20         ## Both file path and directory path are accepted.
  21         "IgnoreFiles": [
  22             "Library/BrotliCustomDecompressLib/brotli",
  23             "Universal/RegularExpressionDxe/oniguruma"
  24         ]
  25     },
  26     ## options defined ci/Plugin/CompilerPlugin
  27     "CompilerPlugin": {
  28         "DscPath": "MdeModulePkg.dsc"
  29     },
  30     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  31     "HostUnitTestCompilerPlugin": {
  32         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  33     },
  34
  35     ## options defined ci/Plugin/CharEncodingCheck
  36     "CharEncodingCheck": {
  37         "IgnoreFiles": [
  38             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",
  39             "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/testc.c"
  40         ]
  41     },
  42
  43     ## options defined ci/Plugin/DependencyCheck
  44     "DependencyCheck": {
  45         "AcceptableDependencies": [
  46             "MdePkg/MdePkg.dec",
  47             "MdeModulePkg/MdeModulePkg.dec",
  48             "StandaloneMmPkg/StandaloneMmPkg.dec",
  49             "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an abstraction
  50         ],
  51         # For host based unit tests
  52         "AcceptableDependencies-HOST_APPLICATION":[
  53             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  54         ],
  55         # For UEFI shell based apps
  56         "AcceptableDependencies-UEFI_APPLICATION":[],
  57         "IgnoreInf": []
  58     },
  59
  60     ## options defined ci/Plugin/DscCompleteCheck
  61     "DscCompleteCheck": {
  62         "IgnoreInf": [],
  63         "DscPath": "MdeModulePkg.dsc"
  64     },
  65     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
  66     "HostUnitTestDscCompleteCheck": {
  67         "IgnoreInf": [""],
  68         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  69     },
  70
  71     ## options defined ci/Plugin/GuidCheck
  72     "GuidCheck": {
  73         "IgnoreGuidName": [],
  74         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
  75         "IgnoreFoldersAndFiles": [],
  76         "IgnoreDuplicates": [
  77             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
  78             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
  79         ]
  80     },
  81
  82     ## options defined ci/Plugin/LibraryClassCheck
  83     "LibraryClassCheck": {
  84         "IgnoreHeaderFile": []
  85     },
  86
  87     ## options defined ci/Plugin/SpellCheck
  88     "SpellCheck": {
  89         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  90         "IgnoreStandardPaths": [     # Standard Plugin defined paths that should be ignore
  91             "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"
  92         ],
  93         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
  94             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
  95         ],
  96         "ExtendWords": [           # words to extend to the dictionary for this package
  97             "LIGHTGRAY",
  98             "DARKGRAY",
  99             "LIGHTBLUE",
 100             "LIGHTGREEN",
 101             "LIGHTCYAN",
 102             "LIGHTRED",
 103             "LIGHTMAGENTA",
 104             "FVMAIN",
 105             "VARCHECKPCD",
 106             "Getxx",
 107             "lzturbo"
 108         ],
 109         "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)
 110     }
 111 }