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