Pierre: There are some discussion on the syntax of the header file macro. I suggest we align the syntax first, then add this checker in ECC tool.
In MdePkg, there are 555 header files. 70% header files use the style __BASE_H__ as the file header macro. Others use the style _BTT_H_. For this case, I would propose to update EDK II C Coding Standards Specification to align the code. Thanks Liming > -----邮件原件----- > 发件人: pierre.gond...@arm.com <pierre.gond...@arm.com> > 发送时间: 2021年1月25日 23:45 > 收件人: devel@edk2.groups.io; bob.c.f...@intel.com; > gaolim...@byosoft.com.cn > 抄送: sami.muja...@arm.com > 主题: [PATCH v1 1/1] BaseTools: Align include guards policy > > From: Pierre Gondois <pierre.gond...@arm.com> > > The EDK II C Coding Standards Specification states that: > "Names starting with one or two underscores, such as > _MACRO_GUARD_FILE_NAME_H_, must not be used. They are > reserved for compiler implementation." [1] > > The Ecc tool currently checks that the include guard end with > a trailing underscore. Thus, the check and the error message > should both be modified. > > The new check forces having one sole trailing underscore > character, as the example in the specification shows: > "FILE_NAME_H_" [1] > This would allow to have more consistency. > > [1] Section 5.3.5 "All include file contents must be protected > by a #include guard": > https://edk2-docs.gitbook.io/ > edk-ii-c-coding-standards-specification/ > 5_source_files/53_include_files > > Signed-off-by: Pierre Gondois <pierre.gond...@arm.com> > --- > BaseTools/Source/Python/Ecc/Check.py | 3 ++- > BaseTools/Source/Python/Ecc/EccToolError.py | 3 ++- > 2 files changed, 4 insertions(+), 2 deletions(-) > > diff --git a/BaseTools/Source/Python/Ecc/Check.py > b/BaseTools/Source/Python/Ecc/Check.py > index 6087abfa4d8d..14759d21f5d8 100644 > --- a/BaseTools/Source/Python/Ecc/Check.py > +++ b/BaseTools/Source/Python/Ecc/Check.py > @@ -2,6 +2,7 @@ > # This file is used to define checkpoints used by ECC tool > # > # Copyright (c) 2008 - 2020, Intel Corporation. All rights reserved.<BR> > +# Copyright (c) 2021, Arm Limited. All rights reserved.<BR> > # SPDX-License-Identifier: BSD-2-Clause-Patent > # > from __future__ import absolute_import > @@ -1438,7 +1439,7 @@ class Check(object): > RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand) > for Record in RecordSet: > Name = Record[1].replace('#ifndef', '').strip() > - if Name[-1] != '_': > + if Name[0] == '_' or Name[-1] != '_' or Name[-2] == '_': > if not > EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHE > CK_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]) > > diff --git a/BaseTools/Source/Python/Ecc/EccToolError.py > b/BaseTools/Source/Python/Ecc/EccToolError.py > index 0ff3b42674d4..58d0749477b2 100644 > --- a/BaseTools/Source/Python/Ecc/EccToolError.py > +++ b/BaseTools/Source/Python/Ecc/EccToolError.py > @@ -2,6 +2,7 @@ > # Standardized Error Handling infrastructures. > # > # Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR> > +# Copyright (c) 2021, Arm Limited. All rights reserved.<BR> > # SPDX-License-Identifier: BSD-2-Clause-Patent > # > > @@ -161,7 +162,7 @@ gEccErrorMessage = { > ERROR_NAMING_CONVENTION_CHECK_ALL : "", > ERROR_NAMING_CONVENTION_CHECK_DEFINE_STATEMENT : "Only > capital letters are allowed to be used for #define declarations", > ERROR_NAMING_CONVENTION_CHECK_TYPEDEF_STATEMENT : "Only > capital letters are allowed to be used for typedef declarations", > - ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT : "The > #ifndef at the start of an include file should use both prefix and postfix > underscore characters, '_'", > + ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT : "The > #ifndef at the start of an include file should have one postfix underscore, and > no prefix underscore character '_'", > ERROR_NAMING_CONVENTION_CHECK_PATH_NAME : """Path name > does not follow the rules: 1. First character should be upper case 2. Must > contain lower case characters 3. No white space characters""", > ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME : > """Variable name does not follow the rules: 1. First character should be upper > case 2. Must contain lower case characters 3. No white space characters 4. > Global variable name must start with a 'g'""", > ERROR_NAMING_CONVENTION_CHECK_FUNCTION_NAME : > """Function name does not follow the rules: 1. First character should be upper > case 2. Must contain lower case characters 3. No white space characters""", > -- > 2.17.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#70748): https://edk2.groups.io/g/devel/message/70748 Mute This Topic: https://groups.io/mt/80121066/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
