tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
audk/.pytool/Plugin/LibraryClassCheck
History
Sean Brogan 9da7846c88 .pytool/Plugin: Add CI plugins 
https://bugzilla.tianocore.org/show_bug.cgi?id=2315

Add .pytool directory to the edk2 repository with the
following plugins.  These plugins are in a top level
directory because that can be used with all packages
and platforms.

* CharEncodingCheck
* CompilerPlugin
* DependencyCheck
* DscCompleteCheck
* GuidCheck
* LibraryClassCheck
* SpellCheck

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
 		2019-11-11 13:02:03 -08:00
..
LibraryClassCheck.py .pytool/Plugin: Add CI plugins 2019-11-11 13:02:03 -08:00
LibraryClassCheck_plug_in.yaml .pytool/Plugin: Add CI plugins 2019-11-11 13:02:03 -08:00
Readme.md .pytool/Plugin: Add CI plugins 2019-11-11 13:02:03 -08:00

Readme.md

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.

"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