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