ArmPkg/ArmPkg.ci.yaml

   1 ## @file
   2 # CI configuration for ArmPkg
   3 #
   4 # Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     ## options defined .pytool/Plugin/LicenseCheck
   9     "LicenseCheck": {
  10         "IgnoreFiles": []
  11     },
  12
  13     "EccCheck": {
  14         ## Exception sample looks like below:
  15         ## "ExceptionList": [
  16         ##     "<ErrorID>", "<KeyWord>"
  17         ## ]
  18         "ExceptionList": [
  19         ],
  20         ## Both file path and directory path are accepted.
  21         "IgnoreFiles": [
  22             "Library/ArmSoftFloatLib/berkeley-softfloat-3"
  23         ]
  24     },
  25
  26     ## options defined .pytool/Plugin/CompilerPlugin
  27     "CompilerPlugin": {
  28         "DscPath": "ArmPkg.dsc"
  29     },
  30
  31     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  32     "HostUnitTestCompilerPlugin": {
  33         "DscPath": "" # Don't support this test
  34     },
  35
  36     ## options defined .pytool/Plugin/CharEncodingCheck
  37     "CharEncodingCheck": {
  38         "IgnoreFiles": []
  39     },
  40
  41     ## options defined .pytool/Plugin/DependencyCheck
  42     "DependencyCheck": {
  43         "AcceptableDependencies": [
  44             "ArmPlatformPkg/ArmPlatformPkg.dec",
  45             "ArmPkg/ArmPkg.dec",
  46             "EmbeddedPkg/EmbeddedPkg.dec",
  47             "MdeModulePkg/MdeModulePkg.dec",
  48             "MdePkg/MdePkg.dec",
  49             "ShellPkg/ShellPkg.dec"
  50         ],
  51         # For host based unit tests
  52         "AcceptableDependencies-HOST_APPLICATION":[
  53             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  54         ],
  55         # For UEFI shell based apps
  56         "AcceptableDependencies-UEFI_APPLICATION":[],
  57         "IgnoreInf": []
  58     },
  59
  60     ## options defined .pytool/Plugin/DscCompleteCheck
  61     "DscCompleteCheck": {
  62         "IgnoreInf": [],
  63         "DscPath": "ArmPkg.dsc"
  64     },
  65
  66     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  67     "HostUnitTestDscCompleteCheck": {
  68         "IgnoreInf": [""],
  69         "DscPath": "" # Don't support this test
  70     },
  71
  72     ## options defined .pytool/Plugin/GuidCheck
  73     "GuidCheck": {
  74         "IgnoreGuidName": [],
  75         "IgnoreGuidValue": [],
  76         "IgnoreFoldersAndFiles": [],
  77         "IgnoreDuplicates": [],
  78     },
  79
  80     ## options defined .pytool/Plugin/LibraryClassCheck
  81     "LibraryClassCheck": {
  82         "IgnoreHeaderFile": []
  83     },
  84
  85     ## options defined .pytool/Plugin/SpellCheck
  86     "SpellCheck": {
  87         "AuditOnly": False,
  88         "IgnoreFiles": [
  89             "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
  90         ],                           # use gitignore syntax to ignore errors
  91                                      # in matching files
  92         "ExtendWords": [
  93           "api's",
  94           "ackintid",
  95           "actlr",
  96           "aeabi",
  97           "asedis",
  98           "ashldi",
  99           "ashrdi",
 100           "baddr",
 101           "ccidx",
 102           "ccsidr",
 103           "clidr",
 104           "clrex",
 105           "clzsi",
 106           "cnthctl",
 107           "cortexa",
 108           "cpacr",
 109           "cpuactlr",
 110           "csselr",
 111           "ctzsi",
 112           "cygdrive",
 113           "cygpaths",
 114           "datas",
 115           "dcmpeq",
 116           "dcmpge",
 117           "dcmpgt",
 118           "dcmple",
 119           "dcmplt",
 120           "ddisable",
 121           "divdi",
 122           "divsi",
 123           "dmdepkg",
 124           "dpref",
 125           "drsub",
 126           "fcmpeq",
 127           "fcmpge",
 128           "fcmpgt",
 129           "fcmple",
 130           "fcmplt",
 131           "ffreestanding",
 132           "frsub",
 133           "hisilicon",
 134           "iccabpr",
 135           "iccbpr",
 136           "icciar",
 137           "iccicr",
 138           "icciidr",
 139           "iccpir",
 140           "iccpmr",
 141           "iccrpr",
 142           "icdabr",
 143           "icdicer",
 144           "icdicfr",
 145           "icdicpr",
 146           "icdictr",
 147           "icdiidr",
 148           "icdiser",
 149           "icdisr",
 150           "icdppisr",
 151           "icdsgir",
 152           "icdspr",
 153           "icenabler",
 154           "intid",
 155           "ipriority",
 156           "irouter",
 157           "isenabler",
 158           "istatus",
 159           "itargets",
 160           "lable",
 161           "ldivmod",
 162           "ldmdb",
 163           "ldmia",
 164           "ldrbt",
 165           "ldrex",
 166           "ldrexb",
 167           "ldrexd",
 168           "ldrexh",
 169           "ldrhbt",
 170           "ldrht",
 171           "ldrsb",
 172           "ldrsbt",
 173           "ldrsh",
 174           "lshrdi",
 175           "moddi",
 176           "modsi",
 177           "mpcore",
 178           "mpidr",
 179           "muldi",
 180           "mullu",
 181           "nonshareable",
 182           "nsacr",
 183           "nsasedis",
 184           "nuvia",
 185           "oldit",
 186           "pcten",
 187           "plpis",
 188           "procno",
 189           "readc",
 190           "revsh",
 191           "rfedb",
 192           "sctlr",
 193           "smccc",
 194           "smlabb",
 195           "smlabt",
 196           "smlad",
 197           "smladx",
 198           "smlatb",
 199           "smlatt",
 200           "smlawb",
 201           "smlawt",
 202           "smlsd",
 203           "smlsdx",
 204           "smmla",
 205           "smmlar",
 206           "smmls",
 207           "smmlsr",
 208           "sourcery",
 209           "srsdb",
 210           "ssacr",
 211           "stmdb",
 212           "stmia",
 213           "strbt",
 214           "strexb",
 215           "strexd",
 216           "strexh",
 217           "strht",
 218           "switchu",
 219           "tpidrurw",
 220           "ttbcr",
 221           "typer",
 222           "ucmpdi",
 223           "udivdi",
 224           "udivmoddi",
 225           "udivsi",
 226           "uefi's",
 227           "uldiv",
 228           "umoddi",
 229           "umodsi",
 230           "usada",
 231           "vlpis",
 232           "writec"
 233         ],                          # words to extend to the dictionary for this package
 234         "IgnoreStandardPaths": [    # Standard Plugin defined paths that
 235             "*.asm", "*.s"          # should be ignore
 236         ],
 237         "AdditionalIncludePaths": [] # Additional paths to spell check
 238                                      # (wildcards supported)
 239     }
 240 }