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