OvmfPkg/OvmfPkg.ci.yaml

   1 ## @file
   2 # Core CI configuration for OvmfPkg
   3 #
   4 # OvmfPkg is part of Platform Ci for builds so this is only
   5 # used for code analysis.
   6 #
   7 # Copyright (c) Microsoft Corporation
   8 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   9 # SPDX-License-Identifier: BSD-2-Clause-Patent
  10 ##
  11 {
  12     ## options defined .pytool/Plugin/LicenseCheck
  13     "LicenseCheck": {
  14         "IgnoreFiles": []
  15     },
  16     "EccCheck": {
  17         ## Exception sample looks like below:
  18         ## "ExceptionList": [
  19         ##     "<ErrorID>", "<KeyWord>"
  20         ## ]
  21         "ExceptionList": [
  22         ],
  23         ## Both file path and directory path are accepted.
  24         "IgnoreFiles": [
  25         ]
  26     },
  27     ## options defined .pytool/Plugin/CompilerPlugin
  28     "CompilerPlugin": {
  29         "DscPath": "" # Don't support this test
  30     },
  31
  32     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  33     "HostUnitTestCompilerPlugin": {
  34         "DscPath": "" # Don't support this test
  35     },
  36
  37     ## options defined .pytool/Plugin/CharEncodingCheck
  38     "CharEncodingCheck": {
  39         "IgnoreFiles": []
  40     },
  41
  42     ## options defined .pytool/Plugin/DependencyCheck
  43     "DependencyCheck": {
  44         "AcceptableDependencies": [
  45             "MdePkg/MdePkg.dec",
  46             "MdeModulePkg/MdeModulePkg.dec",
  47             "OvmfPkg/OvmfPkg.dec",
  48             "NetworkPkg/NetworkPkg.dec",
  49             "SecurityPkg/SecurityPkg.dec",
  50             "UefiCpuPkg/UefiCpuPkg.dec",
  51             "ShellPkg/ShellPkg.dec",
  52             "EmbeddedPkg/EmbeddedPkg.dec",
  53             "SourceLevelDebugPkg/SourceLevelDebugPkg.dec"
  54         ],
  55         # For host based unit tests
  56         "AcceptableDependencies-HOST_APPLICATION":[
  57             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  58         ],
  59         # For UEFI shell based apps
  60         "AcceptableDependencies-UEFI_APPLICATION":[],
  61         "IgnoreInf": []
  62     },
  63
  64     ## options defined .pytool/Plugin/DscCompleteCheck
  65     "DscCompleteCheck": {
  66         "IgnoreInf": [""],
  67         "DscPath": ""  # Don't support this test
  68     },
  69
  70     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  71     "HostUnitTestDscCompleteCheck": {
  72         "IgnoreInf": [""],
  73         "DscPath": "" # Don't support this test
  74     },
  75
  76     ## options defined .pytool/Plugin/GuidCheck
  77     "GuidCheck": {
  78         "IgnoreGuidName": ["ResetVector", "XenResetVector"], # Expected duplication for gEfiFirmwareVolumeTopFileGuid
  79         "IgnoreGuidValue": [],
  80         "IgnoreFoldersAndFiles": [],
  81         "IgnoreDuplicates": [],
  82     },
  83
  84     ## options defined .pytool/Plugin/LibraryClassCheck
  85     "LibraryClassCheck": {
  86         "IgnoreHeaderFile": []
  87     },
  88
  89     ## options defined .pytool/Plugin/SpellCheck
  90     "SpellCheck": {
  91         "AuditOnly": True,           # Fails right now with over 270 errors
  92         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  93         "ExtendWords": [
  94
  95         ],           # words to extend to the dictionary for this package
  96         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  97         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  98     }
  99 }