DynamicTablesPkg/DynamicTablesPkg.ci.yaml

   1 ## @file
   2 # CI configuration for DynamicTablesPkg
   3 #
   4 # Copyright (c) 2020, Arm Limited. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     "EccCheck": {
   9         ## Exception sample looks like below:
  10         ## "ExceptionList": [
  11         ##     "<ErrorID>", "<KeyWord>"
  12         ## ]
  13         "ExceptionList": [
  14         # "The #ifndef at the start of an include file should use
  15         # both prefix and postfix underscore characters, '_'"
  16         # This error is not triggered for the latest BaseTools code.
  17         # @TODO The error should be re-enabled when the python packages
  18         # containing the BaseTools are updated to the latest version.
  19         "8003", "DISABLE_NEW_DEPRECATED_INTERFACES",
  20         "9005", "@defgroup",      # Use extra Doxygen commands
  21         "9005", "@ingroup",       # Use extra Doxygen commands
  22         "9005", "@mainpage",      # Use extra Doxygen commands
  23         "9005", "@ref",           # Use extra Doxygen commands
  24         ],
  25         ## Both file path and directory path are accepted.
  26         "IgnoreFiles": [
  27         ]
  28     },
  29
  30     ## options defined .pytool/Plugin/CompilerPlugin
  31     "CompilerPlugin": {
  32         "DscPath": "DynamicTablesPkg.dsc"
  33     },
  34
  35     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  36     "HostUnitTestCompilerPlugin": {
  37         "DscPath": "" # Don't support this test
  38     },
  39
  40     ## options defined .pytool/Plugin/CharEncodingCheck
  41     "CharEncodingCheck": {
  42         "IgnoreFiles": []
  43     },
  44
  45     ## options defined .pytool/Plugin/DependencyCheck
  46     "DependencyCheck": {
  47         "AcceptableDependencies": [
  48             "ArmPkg/ArmPkg.dec",
  49             "ArmPlatformPkg/ArmPlatformPkg.dec",
  50             "EmbeddedPkg/EmbeddedPkg.dec",
  51             "DynamicTablesPkg/DynamicTablesPkg.dec",
  52             "MdeModulePkg/MdeModulePkg.dec",
  53             "MdePkg/MdePkg.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": "DynamicTablesPkg.dsc"
  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": [],
  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": False,
  92         "IgnoreFiles": [],           # use gitignore syntax to ignore errors
  93                                      # in matching files
  94         "ExtendWords": [
  95            "ARMHB",                  # ARMHB000
  96            "ARMHC",                  # ARMHC600
  97            "ARMLTD",
  98            "AMLDBG",
  99            "EISAID",
 100            "CCIDX",
 101            "CCSIDR",
 102            "countof",
 103            "edynamic",
 104            "EOBJECT",
 105            "invoc",
 106            "ITARGETSR",
 107            "GTBLOCK",
 108            "lgreater",
 109            "lless",
 110            "MPIDR",
 111            "PERIPHBASE",
 112            "phandle",
 113            "pytool",
 114            "Rdword",
 115            "Roadmap",
 116            "ROOTNODEBASE",
 117            "ssdtcmn",
 118            "ssdtserialporttemplate",
 119            "SMMUV",
 120            "ssdtpcieosctemplate",
 121            "SSDTPC",
 122            "standardised",
 123            "TABLEEX",
 124            "TNSID",
 125            "Vatos",
 126            "WBINVD"
 127            ],           # words to extend to the dictionary for this package
 128         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that
 129                                      # should be ignore
 130         "AdditionalIncludePaths": [] # Additional paths to spell check
 131                                      # (wildcards supported)
 132     }
 133 }