public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* ECC tool incorrectly reports that include guards must have prefix and postfix underscores
@ 2020-11-30 15:36 Rebecca Cran
  0 siblings, 0 replies; only message in thread
From: Rebecca Cran @ 2020-11-30 15:36 UTC (permalink / raw)
  To: devel@edk2.groups.io; +Cc: Leif Lindholm

I came across what appears to be a bug in the ECC tool. I was running my 
bhyve changes through a personal EDK2 Github build, and ECC failed with 
the ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT:


./Source/Python/Ecc/EccToolError.py:164: 
ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT : "The #ifndef at the 
start of an include file should use both prefix and postfix underscore 
characters, '_'"


It appears the tool really only checks that there's at least one 
underscore, so it seems it does _allow_ the style documented in the C 
coding standard 
(https://edk2-docs.gitbook.io/edk-ii-c-coding-standards-specification/5_source_files/53_include_files#5-3-5-all-include-file-contents-must-be-protected-by-a-include-guard), 
which has a postfix underscore but which explicitly disallows prefix 
underscore(s).


I've created https://bugzilla.tianocore.org/show_bug.cgi?id=3094 .


-- 
Rebecca Cran


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2020-11-30 15:36 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-11-30 15:36 ECC tool incorrectly reports that include guards must have prefix and postfix underscores Rebecca Cran

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox