]> git.proxmox.com Git - mirror_edk2.git/commitdiff
BaseTools/Ecc: Make Ecc only check first include guard
authorPierre Gondois <Pierre.Gondois@arm.com>
Wed, 17 Mar 2021 09:59:37 +0000 (17:59 +0800)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Thu, 18 Mar 2021 02:04:18 +0000 (02:04 +0000)
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.Gondois@arm.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
BaseTools/Source/Python/Ecc/Check.py

index 7a012617fd357cfe75ee1938d1cbc0efce9a4dbc..33060db5f27a73bc0a72885053f6b7cbec7a771d 100644 (file)
@@ -1437,11 +1437,13 @@ class Check(object):
 \r
             SqlCommand = """select ID, Value from %s where Model = %s""" % (FileTable, MODEL_IDENTIFIER_MACRO_IFNDEF)\r
             RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
-            for Record in RecordSet:\r
-                Name = Record[1].replace('#ifndef', '').strip()\r
+            if RecordSet:\r
+                # Only check the first ifndef statement of the file\r
+                FirstDefine = sorted(RecordSet, key=lambda Record: Record[0])[0]\r
+                Name = FirstDefine[1].replace('#ifndef', '').strip()\r
                 if Name[0] == '_' or Name[-1] != '_' or Name[-2] == '_':\r
                     if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):\r
-                        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])\r
+                        EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg="The #ifndef name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=FirstDefine[0])\r
 \r
     # Rule for path name, variable name and function name\r
     # 1. First character should be upper case\r