7a8c037e9e
To prepare edk2 upstream CI for incoming modifications:
1- Disable the Ecc check 9005:
"Only Doxygen commands '@bug', '@todo', [...], '@{', '@}'
are allowed to mark the code Unknown doxygen command [...]"
2- Disable the Ecc check 8003 for the following keyword:
"DISABLE_NEW_DEPRECATED_INTERFACES"
Indeed, this error has been corrected on the latest version of
BaseTools, but is still triggered when using the older python
packages containing the BaseTools.
3- Add word exceptions for the cspell tool.
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
134 lines
4.2 KiB
YAML
134 lines
4.2 KiB
YAML
## @file
|
|
# CI configuration for DynamicTablesPkg
|
|
#
|
|
# Copyright (c) 2020, Arm Limited. All rights reserved.<BR>
|
|
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
##
|
|
{
|
|
"EccCheck": {
|
|
## Exception sample looks like below:
|
|
## "ExceptionList": [
|
|
## "<ErrorID>", "<KeyWord>"
|
|
## ]
|
|
"ExceptionList": [
|
|
# "The #ifndef at the start of an include file should use
|
|
# both prefix and postfix underscore characters, '_'"
|
|
# This error is not triggered for the latest BaseTools code.
|
|
# @TODO The error should be re-enabled when the python packages
|
|
# containing the BaseTools are updated to the latest version.
|
|
"8003", "DISABLE_NEW_DEPRECATED_INTERFACES",
|
|
"9005", "@defgroup", # Use extra Doxygen commands
|
|
"9005", "@ingroup", # Use extra Doxygen commands
|
|
"9005", "@mainpage", # Use extra Doxygen commands
|
|
"9005", "@ref", # Use extra Doxygen commands
|
|
],
|
|
## Both file path and directory path are accepted.
|
|
"IgnoreFiles": [
|
|
]
|
|
},
|
|
|
|
## options defined .pytool/Plugin/CompilerPlugin
|
|
"CompilerPlugin": {
|
|
"DscPath": "DynamicTablesPkg.dsc"
|
|
},
|
|
|
|
## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
|
|
"HostUnitTestCompilerPlugin": {
|
|
"DscPath": "" # Don't support this test
|
|
},
|
|
|
|
## options defined .pytool/Plugin/CharEncodingCheck
|
|
"CharEncodingCheck": {
|
|
"IgnoreFiles": []
|
|
},
|
|
|
|
## options defined .pytool/Plugin/DependencyCheck
|
|
"DependencyCheck": {
|
|
"AcceptableDependencies": [
|
|
"ArmPkg/ArmPkg.dec",
|
|
"ArmPlatformPkg/ArmPlatformPkg.dec",
|
|
"EmbeddedPkg/EmbeddedPkg.dec",
|
|
"DynamicTablesPkg/DynamicTablesPkg.dec",
|
|
"MdeModulePkg/MdeModulePkg.dec",
|
|
"MdePkg/MdePkg.dec"
|
|
],
|
|
# For host based unit tests
|
|
"AcceptableDependencies-HOST_APPLICATION":[
|
|
"UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
|
|
],
|
|
# For UEFI shell based apps
|
|
"AcceptableDependencies-UEFI_APPLICATION":[],
|
|
"IgnoreInf": []
|
|
},
|
|
|
|
## options defined .pytool/Plugin/DscCompleteCheck
|
|
"DscCompleteCheck": {
|
|
"IgnoreInf": [],
|
|
"DscPath": "DynamicTablesPkg.dsc"
|
|
},
|
|
|
|
## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
|
|
"HostUnitTestDscCompleteCheck": {
|
|
"IgnoreInf": [""],
|
|
"DscPath": "" # Don't support this test
|
|
},
|
|
|
|
## options defined .pytool/Plugin/GuidCheck
|
|
"GuidCheck": {
|
|
"IgnoreGuidName": [],
|
|
"IgnoreGuidValue": [],
|
|
"IgnoreFoldersAndFiles": [],
|
|
"IgnoreDuplicates": [],
|
|
},
|
|
|
|
## options defined .pytool/Plugin/LibraryClassCheck
|
|
"LibraryClassCheck": {
|
|
"IgnoreHeaderFile": []
|
|
},
|
|
|
|
## options defined .pytool/Plugin/SpellCheck
|
|
"SpellCheck": {
|
|
"AuditOnly": False,
|
|
"IgnoreFiles": [], # use gitignore syntax to ignore errors
|
|
# in matching files
|
|
"ExtendWords": [
|
|
"ARMHB", # ARMHB000
|
|
"ARMHC", # ARMHC600
|
|
"ARMLTD",
|
|
"AMLDBG",
|
|
"EISAID",
|
|
"CCIDX",
|
|
"CCSIDR",
|
|
"countof",
|
|
"edynamic",
|
|
"EOBJECT",
|
|
"invoc",
|
|
"ITARGETSR",
|
|
"GTBLOCK",
|
|
"lgreater",
|
|
"lless",
|
|
"MPIDR",
|
|
"PERIPHBASE",
|
|
"phandle",
|
|
"pytool",
|
|
"Rdword",
|
|
"Roadmap",
|
|
"ROOTNODEBASE",
|
|
"ssdtcmn",
|
|
"ssdtserialporttemplate",
|
|
"SMMUV",
|
|
"ssdtpcieosctemplate",
|
|
"SSDTPC",
|
|
"standardised",
|
|
"TABLEEX",
|
|
"TNSID",
|
|
"Vatos",
|
|
"WBINVD"
|
|
], # words to extend to the dictionary for this package
|
|
"IgnoreStandardPaths": [], # Standard Plugin defined paths that
|
|
# should be ignore
|
|
"AdditionalIncludePaths": [] # Additional paths to spell check
|
|
# (wildcards supported)
|
|
}
|
|
}
|