• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..02-Mar-2021-

DscCompleteCheck.pyH A D02-Mar-20215.7 KiB13492

DscCompleteCheck_plug_in.yamlH A D02-Mar-2021301 1312

Readme.mdH A D02-Mar-20211 KiB3322

Readme.md

1# Dsc Complete Check Plugin
2
3This CiBuildPlugin scans all INF files from a package and confirms they are
4listed in the package level DSC file. The test considers it an error if any INF
5does not appear in the `Components` section of the package-level DSC (indicating
6that it would not be built if the package were built). This is critical because
7much of the CI infrastructure assumes that all modules will be listed in the DSC
8and compiled.
9
10This test will ignore INFs in the following cases:
11
121. When MODULE_TYPE = HOST_APPLICATION
132. When a Library instance **only** supports the HOST_APPLICATION environment
14
15## Configuration
16
17The plugin has a few configuration options to support the UEFI codebase.
18
19``` yaml
20"DscCompleteCheck": {
21        "DscPath": "",   # Path to dsc from root of package
22        "IgnoreInf": []  # Ignore INF if found in filesystem but not dsc
23    }
24```
25
26### DscPath
27
28Path to DSC to consider platform dsc
29
30### IgnoreInf
31
32Ignore error if Inf file is not listed in DSC file
33