Maintainers.txt: Update email address
[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.ci.yaml
CommitLineData
e4612477
MK
1## @file\r
2# CI configuration for MdeModulePkg\r
3#\r
4# Copyright (c) Microsoft Corporation\r
32ed3624 5# Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
4c051c2c 6# (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>\r
e4612477
MK
7# SPDX-License-Identifier: BSD-2-Clause-Patent\r
8##\r
9{\r
1b647d65
SZ
10 ## options defined .pytool/Plugin/LicenseCheck\r
11 "LicenseCheck": {\r
12 "IgnoreFiles": []\r
13 },\r
32ed3624
SZ
14 "EccCheck": {\r
15 ## Exception sample looks like below:\r
16 ## "ExceptionList": [\r
17 ## "<ErrorID>", "<KeyWord>"\r
18 ## ]\r
19 "ExceptionList": [\r
b597b6e2
ZL
20 "8005", "UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE.UID",\r
21 "8005", "UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE.HID",\r
ac826886 22 "8001", "UefiSortLibUnitTestMain",\r
32ed3624
SZ
23 ],\r
24 ## Both file path and directory path are accepted.\r
25 "IgnoreFiles": [\r
9deb9370
MK
26 "Library/LzmaCustomDecompressLib",\r
27 "Library/BrotliCustomDecompressLib",\r
28 "Universal/RegularExpressionDxe"\r
32ed3624
SZ
29 ]\r
30 },\r
e4612477
MK
31 ## options defined ci/Plugin/CompilerPlugin\r
32 "CompilerPlugin": {\r
33 "DscPath": "MdeModulePkg.dsc"\r
34 },\r
184ee9b1
MK
35 ## options defined ci/Plugin/HostUnitTestCompilerPlugin\r
36 "HostUnitTestCompilerPlugin": {\r
37 "DscPath": "Test/MdeModulePkgHostTest.dsc"\r
38 },\r
e4612477
MK
39\r
40 ## options defined ci/Plugin/CharEncodingCheck\r
41 "CharEncodingCheck": {\r
48b6c60c
SZ
42 "IgnoreFiles": [\r
43 "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/test/testc.c",\r
44 "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma/windows/testc.c"\r
45 ]\r
e4612477
MK
46 },\r
47\r
48 ## options defined ci/Plugin/DependencyCheck\r
49 "DependencyCheck": {\r
50 "AcceptableDependencies": [\r
51 "MdePkg/MdePkg.dec",\r
52 "MdeModulePkg/MdeModulePkg.dec",\r
53 "StandaloneMmPkg/StandaloneMmPkg.dec",\r
54 "ArmPkg/ArmPkg.dec" # this should be fixed by promoting an abstraction\r
55 ],\r
56 # For host based unit tests\r
184ee9b1
MK
57 "AcceptableDependencies-HOST_APPLICATION":[\r
58 "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"\r
59 ],\r
e4612477
MK
60 # For UEFI shell based apps\r
61 "AcceptableDependencies-UEFI_APPLICATION":[],\r
62 "IgnoreInf": []\r
63 },\r
64\r
65 ## options defined ci/Plugin/DscCompleteCheck\r
66 "DscCompleteCheck": {\r
67 "IgnoreInf": [],\r
68 "DscPath": "MdeModulePkg.dsc"\r
69 },\r
184ee9b1
MK
70 ## options defined ci/Plugin/HostUnitTestDscCompleteCheck\r
71 "HostUnitTestDscCompleteCheck": {\r
72 "IgnoreInf": [""],\r
73 "DscPath": "Test/MdeModulePkgHostTest.dsc"\r
74 },\r
e4612477
MK
75\r
76 ## options defined ci/Plugin/GuidCheck\r
77 "GuidCheck": {\r
78 "IgnoreGuidName": [],\r
79 "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],\r
80 "IgnoreFoldersAndFiles": [],\r
81 "IgnoreDuplicates": [\r
e4612477
MK
82 "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",\r
83 "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",\r
9e950cda 84 "gEfiPeiMmCommunicationPpiGuid=gEfiPeiSmmCommunicationPpiGuid",\r
e4612477
MK
85 ]\r
86 },\r
87\r
88 ## options defined ci/Plugin/LibraryClassCheck\r
89 "LibraryClassCheck": {\r
90 "IgnoreHeaderFile": []\r
91 },\r
92\r
93 ## options defined ci/Plugin/SpellCheck\r
94 "SpellCheck": {\r
95 "AuditOnly": True, # Fails test but run in AuditOnly mode to collect log\r
96 "IgnoreStandardPaths": [ # Standard Plugin defined paths that should be ignore\r
97 "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"\r
98 ],\r
99 "IgnoreFiles": [ # use gitignore syntax to ignore errors in matching files\r
100 "Library/LzmaCustomDecompressLib/Sdk/DOC/*"\r
101 ],\r
102 "ExtendWords": [ # words to extend to the dictionary for this package\r
103 "LIGHTGRAY",\r
104 "DARKGRAY",\r
105 "LIGHTBLUE",\r
106 "LIGHTGREEN",\r
107 "LIGHTCYAN",\r
108 "LIGHTRED",\r
109 "LIGHTMAGENTA",\r
110 "FVMAIN",\r
111 "VARCHECKPCD",\r
112 "Getxx",\r
355b181f
BB
113 "lzturbo",\r
114 "musthave",\r
115 "canthave"\r
e4612477
MK
116 ],\r
117 "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)\r
118 }\r
119}\r