Create a PR https://github.com/tianocore/edk2/pull/1500
Thanks, Bob -----Original Message----- From: pierre.gond...@arm.com <pierre.gond...@arm.com> Sent: Wednesday, March 17, 2021 6:00 PM To: devel@edk2.groups.io; Feng, Bob C <bob.c.f...@intel.com>; gaolim...@byosoft.com.cn; Chen, Christine <yuwei.c...@intel.com> Subject: [PATCH v3 1/1] BaseTools/Ecc: Make Ecc only check first include guard From: Pierre Gondois <pierre.gond...@arm.com> The Ecc tool checks the format of the include guard. This check is currently done on all the names following the '#ifndef' statement. It should only be done on the first include guard. REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3252 Signed-off-by: Pierre Gondois <pierre.gond...@arm.com> Reviewed-by: Liming Gao <liming....@intel.com> Reviewed-by: Bob Feng <bob.c.f...@intel.com> --- The changes can be seen at: https://github.com/PierreARM/edk2/tree/1640_Ecc_tool_corrections_v3 Notes: v2: - Remove duplicated copyright. - Add Bob Feng's reviewed-by. - Add Liming Gao's reviewed-by (resend). v3: - Correct bad formatting of patch (not-possible to apply the patch). [Bob] BaseTools/Source/Python/Ecc/Check.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/BaseTools/Source/Python/Ecc/Check.py b/BaseTools/Source/Python/Ecc/Check.py index 7a012617fd35..33060db5f27a 100644 --- a/BaseTools/Source/Python/Ecc/Check.py +++ b/BaseTools/Source/Python/Ecc/Check.py @@ -1437,11 +1437,13 @@ class Check(object): SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF) RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand) - for Record in RecordSet: - Name = Record[1].replace('#ifndef', '').strip() + if RecordSet: + # Only check the first ifndef statement of the file + FirstDefine = sorted(RecordSet, key=lambda Record: Record[0])[0] + Name = FirstDefine[1].replace('#ifndef', '').strip() if Name[0] == '_' or Name[-1] != '_' or Name[-2] == '_': if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name): - EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg="The #ifndef name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=Record[0]) + + EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDE + F_STATEMENT, OtherMsg="The #ifndef name [%s] does not follow the + rules" % (Name), BelongsToTable=FileTable, + BelongsToItem=FirstDefine[0]) # Rule for path name, variable name and function name # 1. First character should be upper case -- 2.17.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#72996): https://edk2.groups.io/g/devel/message/72996 Mute This Topic: https://groups.io/mt/81399273/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-