summaryrefslogtreecommitdiffstats
path: root/.pytool/Plugin/DependencyCheck/Readme.md
blob: 62612f696523b62aa45a67e3c25740ca811a63e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Depdendency Check Plugin

A CiBuildPlugin that finds all modules (inf files) in a package and reviews the
packages used to confirm they are acceptable.  This is to help enforce layering
and identify improper dependencies between packages.

## Configuration

The plugin must be configured with the acceptabe package dependencies for the
package.

``` yaml
"DependencyCheck": {
    "AcceptableDependencies": [],
    "AcceptableDependencies-<MODULE_TYPE>": [],
    "IgnoreInf": []
}
```

### AcceptableDependencies

Package dec files that are allowed in all INFs.  Example: MdePkg/MdePkg.dec

### AcceptableDependencies-<MODULE_TYPE>

OPTIONAL Package dependencies for INFs that have module type <MODULE_TYPE>.
Example: AcceptableDependencies-HOST_APPLICATION.

### IgnoreInf

OPTIONAL list of INFs to ignore for this dependency check.