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         "skip": True
  27     },
  28     ## options defined .pytool/Plugin/CompilerPlugin
  29     "CompilerPlugin": {
  30         "DscPath": "" # Don't support this test
  31     },
  32
  33     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  34     "HostUnitTestCompilerPlugin": {
  35         "DscPath": "" # Don't support this test
  36     },
  37
  38     ## options defined .pytool/Plugin/CharEncodingCheck
  39     "CharEncodingCheck": {
  40         "IgnoreFiles": []
  41     },
  42
  43     ## options defined .pytool/Plugin/DependencyCheck
  44     "DependencyCheck": {
  45         "AcceptableDependencies": [
  46             "CryptoPkg/CryptoPkg.dec",
  47             "MdePkg/MdePkg.dec",
  48             "MdeModulePkg/MdeModulePkg.dec",
  49             "OvmfPkg/OvmfPkg.dec",
  50             "NetworkPkg/NetworkPkg.dec",
  51             "SecurityPkg/SecurityPkg.dec",
  52             "UefiCpuPkg/UefiCpuPkg.dec",
  53             "ShellPkg/ShellPkg.dec",
  54             "EmbeddedPkg/EmbeddedPkg.dec",
  55             "SourceLevelDebugPkg/SourceLevelDebugPkg.dec"
  56         ],
  57         # For host based unit tests
  58         "AcceptableDependencies-HOST_APPLICATION":[
  59             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  60         ],
  61         # For UEFI shell based apps
  62         "AcceptableDependencies-UEFI_APPLICATION":[],
  63         "IgnoreInf": []
  64     },
  65
  66     ## options defined .pytool/Plugin/DscCompleteCheck
  67     "DscCompleteCheck": {
  68         "IgnoreInf": [""],
  69         "DscPath": ""  # Don't support this test
  70     },
  71
  72     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  73     "HostUnitTestDscCompleteCheck": {
  74         "IgnoreInf": [""],
  75         "DscPath": "" # Don't support this test
  76     },
  77
  78     ## options defined .pytool/Plugin/GuidCheck
  79     "GuidCheck": {
  80         "IgnoreGuidName": ["ResetVector", "XenResetVector"], # Expected duplication for gEfiFirmwareVolumeTopFileGuid
  81         "IgnoreGuidValue": [],
  82         "IgnoreFoldersAndFiles": [],
  83         "IgnoreDuplicates": ["gGrubFileGuid=Grub"],
  84     },
  85
  86     ## options defined .pytool/Plugin/LibraryClassCheck
  87     "LibraryClassCheck": {
  88         "IgnoreHeaderFile": []
  89     },
  90
  91     ## options defined .pytool/Plugin/SpellCheck
  92     "SpellCheck": {
  93         "AuditOnly": True,           # Fails right now with over 270 errors
  94         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  95         "ExtendWords": [
  96
  97         ],           # words to extend to the dictionary for this package
  98         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  99         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
 100     },
 101
 102     # options defined in .pytool/Plugin/UncrustifyCheck
 103     "UncrustifyCheck": {
 104       "IgnoreFiles": ["VbeShim.h"]
 105     }
 106 }