A number of packages have ECC issues that were present before the ECC check was enabled, or there have been no patch reviews against the lines of code in those packages that have ECC errors. The work on the uncrustify source formatting tool is modifying many lines of source files in packages that do have ECC issues. These ECC issues do need to be reviewed and fixed, but that work can be deferred till after the uncrustify source format changes are made. The temporary fix is to amend the EccCheck section of the Package YAML files with a set of IgnoreErrors and IgnoreFiles statements to remove errors reported by the ECC tool.
Assign to owner
Hello Michael, I don't understand why we need to exclude some files/folders from the EccCheck to enable Uncrustify. Aren't they two different tools ? How do the files/folders are selected ? From what I saw, even with the files/folders that are newly excluded, there are still EccError that are triggered. For instance, in the ArmPlatformPkg: - Error 9003 - ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashBlockIoDxe.c -The first line of text in a comment block should be a brief description of the element being documented and the brief description must end with a period. - line 109 is an error that remains. (remainder: ArmPlatformPkg/Drivers/PL061GpioDxe/PL061Gpio.c is to be excluded from the EccCheck, but not ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashBlockIoDxe.c). Regards, Pierre
I think I now understand why some files are excluded, but shouldn't them be re-included once the Uncrustify modifications have been merged ?
Each package owner need to review their YAML files and work on address all ECC issues. We can open new issues for each package. The goal should be no ECC exceptions in any package and the YAML files have no ECC exceptions listed and from that point forward any proposed code change that has an ECC issues will be caught by EDK II CI and require submitter to resolve before it can be merged.
Merged in PR: https://github.com/tianocore/edk2/pull/2218 Commit range: https://github.com/tianocore/edk2/pull/2218/commits/fc85cbd7ebeb4756d242ca4720507b8c7b386c24 ... https://github.com/tianocore/edk2/pull/2218/commits/49ad9df29563627cae27c7bcb673f5a34af51d1e Code Review Email: https://edk2.groups.io/g/devel/message/83983
