ArmPkg: Add ArmPkg.ci.yaml

[mirror_edk2.git] / ArmPkg / ArmPkg.ci.yaml

## @file\r
# CI configuration for ArmPkg\r
#\r
# Copyright (c) 2021, Arm Limited. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
{\r
    ## options defined .pytool/Plugin/LicenseCheck\r
    "LicenseCheck": {\r
        "IgnoreFiles": []\r
    },\r
\r
    "EccCheck": {\r
        ## Exception sample looks like below:\r
        ## "ExceptionList": [\r
        ##     "<ErrorID>", "<KeyWord>"\r
        ## ]\r
        "ExceptionList": [\r
        ],\r
        ## Both file path and directory path are accepted.\r
        "IgnoreFiles": [\r
            "Library/ArmSoftFloatLib/berkeley-softfloat-3"\r
        ]\r
    },\r
\r
    ## options defined .pytool/Plugin/CompilerPlugin\r
    "CompilerPlugin": {\r
        "DscPath": "ArmPkg.dsc"\r
    },\r
\r
    ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin\r
    "HostUnitTestCompilerPlugin": {\r
        "DscPath": "" # Don't support this test\r
    },\r
\r
    ## options defined .pytool/Plugin/CharEncodingCheck\r
    "CharEncodingCheck": {\r
        "IgnoreFiles": []\r
    },\r
\r
    ## options defined .pytool/Plugin/DependencyCheck\r
    "DependencyCheck": {\r
        "AcceptableDependencies": [\r
            "ArmPlatformPkg/ArmPlatformPkg.dec",\r
            "ArmPkg/ArmPkg.dec",\r
            "EmbeddedPkg/EmbeddedPkg.dec",\r
            "MdeModulePkg/MdeModulePkg.dec",\r
            "MdePkg/MdePkg.dec",\r
            "ShellPkg/ShellPkg.dec"\r
        ],\r
        # For host based unit tests\r
        "AcceptableDependencies-HOST_APPLICATION":[\r
            "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"\r
        ],\r
        # For UEFI shell based apps\r
        "AcceptableDependencies-UEFI_APPLICATION":[],\r
        "IgnoreInf": []\r
    },\r
\r
    ## options defined .pytool/Plugin/DscCompleteCheck\r
    "DscCompleteCheck": {\r
        "IgnoreInf": [],\r
        "DscPath": "ArmPkg.dsc"\r
    },\r
\r
    ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck\r
    "HostUnitTestDscCompleteCheck": {\r
        "IgnoreInf": [""],\r
        "DscPath": "" # Don't support this test\r
    },\r
\r
    ## options defined .pytool/Plugin/GuidCheck\r
    "GuidCheck": {\r
        "IgnoreGuidName": [],\r
        "IgnoreGuidValue": [],\r
        "IgnoreFoldersAndFiles": [],\r
        "IgnoreDuplicates": [],\r
    },\r
\r
    ## options defined .pytool/Plugin/LibraryClassCheck\r
    "LibraryClassCheck": {\r
        "IgnoreHeaderFile": []\r
    },\r
\r
    ## options defined .pytool/Plugin/SpellCheck\r
    "SpellCheck": {\r
        "AuditOnly": False,\r
        "IgnoreFiles": [\r
            "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"\r
        ],                           # use gitignore syntax to ignore errors\r
                                     # in matching files\r
        "ExtendWords": [\r
          "api's",\r
          "ackintid",\r
          "actlr",\r
          "aeabi",\r
          "ashldi",\r
          "ashrdi",\r
          "ccidx",\r
          "ccsidr",\r
          "clidr",\r
          "clrex",\r
          "clzsi",\r
          "cpuactlr",\r
          "csselr",\r
          "ctzsi",\r
          "cygdrive",\r
          "cygpaths",\r
          "datas",\r
          "dcmpeq",\r
          "dcmpge",\r
          "dcmpgt",\r
          "dcmple",\r
          "dcmplt",\r
          "ddisable",\r
          "divdi",\r
          "divsi",\r
          "dmdepkg",\r
          "drsub",\r
          "fcmpeq",\r
          "fcmpge",\r
          "fcmpgt",\r
          "fcmple",\r
          "fcmplt",\r
          "ffreestanding",\r
          "frsub",\r
          "hisilicon",\r
          "iccbpr",\r
          "icciar",\r
          "iccicr",\r
          "icciidr",\r
          "iccpmr",\r
          "icdicer",\r
          "icdicfr",\r
          "icdictr",\r
          "icdiser",\r
          "icdisr",\r
          "icdsgir",\r
          "icenabler",\r
          "intid",\r
          "ipriority",\r
          "irouter",\r
          "isenabler",\r
          "istatus",\r
          "itargets",\r
          "lable",\r
          "ldivmod",\r
          "ldmdb",\r
          "ldmia",\r
          "ldrbt",\r
          "ldrex",\r
          "ldrexb",\r
          "ldrexd",\r
          "ldrexh",\r
          "ldrhbt",\r
          "ldrht",\r
          "ldrsb",\r
          "ldrsbt",\r
          "ldrsh",\r
          "lshrdi",\r
          "moddi",\r
          "modsi",\r
          "mpidr",\r
          "muldi",\r
          "mullu",\r
          "nonshareable",\r
          "nsacr",\r
          "nsasedis",\r
          "nuvia",\r
          "oldit",\r
          "readc",\r
          "revsh",\r
          "rfedb",\r
          "sctlr",\r
          "smccc",\r
          "smlabb",\r
          "smlabt",\r
          "smlad",\r
          "smladx",\r
          "smlatb",\r
          "smlatt",\r
          "smlawb",\r
          "smlawt",\r
          "smlsd",\r
          "smlsdx",\r
          "smmla",\r
          "smmlar",\r
          "smmls",\r
          "smmlsr",\r
          "sourcery",\r
          "srsdb",\r
          "stmdb",\r
          "stmia",\r
          "strbt",\r
          "strexb",\r
          "strexd",\r
          "strexh",\r
          "strht",\r
          "switchu",\r
          "tpidrurw",\r
          "ttbcr",\r
          "typer",\r
          "ucmpdi",\r
          "udivdi",\r
          "udivmoddi",\r
          "udivsi",\r
          "uefi's",\r
          "uldiv",\r
          "umoddi",\r
          "umodsi",\r
          "usada",\r
          "vlpis",\r
          "writec"\r
        ],                          # words to extend to the dictionary for this package\r
        "IgnoreStandardPaths": [    # Standard Plugin defined paths that\r
            "*.asm", "*.s"          # should be ignore\r
        ],\r
        "AdditionalIncludePaths": [] # Additional paths to spell check\r
                                     # (wildcards supported)\r
    }\r
}\r