Readme.md
1# Library Class Check Plugin
2
3This CiBuildPlugin scans at all library header files found in the `Library`
4folders in all of the package's declared include directories and ensures that
5all files have a matching LibraryClass declaration in the DEC file for the
6package. Any missing declarations will cause a failure.
7
8## Configuration
9
10The plugin has a few configuration options to support the UEFI codebase.
11
12``` yaml
13"LibraryClassCheck": {
14 IgnoreHeaderFile: [], # Ignore a file found on disk
15 IgnoreLibraryClass: [] # Ignore a declaration found in dec file
16}
17```
18
19### IgnoreHeaderFile
20
21Ignore a file found on disk
22
23### IgnoreLibraryClass
24
25Ignore a declaration found in dec file
26