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