summaryrefslogtreecommitdiffstats
path: root/src/VBox/Devices/EFI/Firmware/.pytool/Plugin/LibraryClassCheck/Readme.md
blob: 95f22e7b09fb38eb7ecda66fa18ec07e8953e265 (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
# Library Class Check Plugin

This CiBuildPlugin scans at all library header files found in the `Library`
folders in all of the package's declared include directories and ensures that
all files have a matching LibraryClass declaration in the DEC file for the
package. Any missing declarations will cause a failure.

## Configuration

The plugin has a few configuration options to support the UEFI codebase.

``` yaml
"LibraryClassCheck": {
    IgnoreHeaderFile: [],  # Ignore a file found on disk
    IgnoreLibraryClass: [] # Ignore a declaration found in dec file
}
```

### IgnoreHeaderFile

Ignore a file found on disk

### IgnoreLibraryClass

Ignore a declaration found in dec file