* [PATCH] BaseTools:ECC fails to detect function header comments issue
@ 2020-01-20 8:40 Fan, ZhijuX
2020-01-21 1:35 ` Bob Feng
0 siblings, 1 reply; 2+ messages in thread
From: Fan, ZhijuX @ 2020-01-20 8:40 UTC (permalink / raw)
To: devel@edk2.groups.io; +Cc: Gao, Liming, Feng, Bob C
[-- Attachment #1: Type: text/plain, Size: 2687 bytes --]
BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1523
When the keyword after @param doesn't match the actual function
parameter name, ECC doesn't detect such issue
The patch is going to fix this issue
Cc: Liming Gao <liming.gao@intel.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
---
BaseTools/Source/Python/Ecc/c.py | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/BaseTools/Source/Python/Ecc/c.py b/BaseTools/Source/Python/Ecc/c.py
index a30122a45f..e42463952d 100644
--- a/BaseTools/Source/Python/Ecc/c.py
+++ b/BaseTools/Source/Python/Ecc/c.py
@@ -2554,6 +2554,20 @@ def CheckGeneralDoxygenCommentLayout(Str, StartLine, ErrorMsgList, CommentId= -1
ErrorMsgList.append('Line %d : @retval appear before @param ' % StartLine)
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, @retval appear before @param ', TableName, CommentId)
+def CheckParamName(ParamName, Tag):
+ ParamList = Tag.split()
+ if len(ParamList) > 1:
+ ParamList.pop(0)
+ for Item in ParamList:
+ if Item.find('[') > 0 and Item.find(']') > 0:
+ continue
+ if ParamName != Item.strip():
+ return True
+ else:
+ return False
+ else:
+ return True
+
def CheckFunctionHeaderConsistentWithDoxygenComment(FuncModifier, FuncHeader, FuncStartLine, CommentStr, CommentStartLine, ErrorMsgList, CommentId= -1, TableName=''):
ParamList = GetParamList(FuncHeader)
@@ -2608,7 +2622,7 @@ def CheckFunctionHeaderConsistentWithDoxygenComment(FuncModifier, FuncHeader, Fu
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT have %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'), TableName, CommentId)
- if Tag.find(ParamName) == -1 and ParamName != 'VOID' and ParamName != 'void':
+ if (Tag.find(ParamName) == -1 or CheckParamName(ParamName, Tag)) and ParamName != 'VOID' and ParamName != 'void':
ErrorMsgList.append('Line %d : in Comment, <%s> does NOT consistent with parameter name %s ' % (CommentStartLine, (TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName))
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT consistent with parameter name %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName), TableName, CommentId)
Index += 1
--
2.14.1.windows.1
[-- Attachment #2: winmail.dat --]
[-- Type: application/ms-tnef, Size: 6301 bytes --]
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] BaseTools:ECC fails to detect function header comments issue
2020-01-20 8:40 [PATCH] BaseTools:ECC fails to detect function header comments issue Fan, ZhijuX
@ 2020-01-21 1:35 ` Bob Feng
0 siblings, 0 replies; 2+ messages in thread
From: Bob Feng @ 2020-01-21 1:35 UTC (permalink / raw)
To: Fan, ZhijuX, devel@edk2.groups.io; +Cc: Gao, Liming
I have 2 comments.
1. CheckParamName may return None. But according to other part of this function, it should return True or False.
2. The meaning of ParamList.pop(0) is not much clear.
Thanks,
Bob
-----Original Message-----
From: Fan, ZhijuX
Sent: Monday, January 20, 2020 4:40 PM
To: devel@edk2.groups.io
Cc: Gao, Liming <liming.gao@intel.com>; Feng, Bob C <bob.c.feng@intel.com>
Subject: [PATCH] BaseTools:ECC fails to detect function header comments issue
BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=1523
When the keyword after @param doesn't match the actual function parameter name, ECC doesn't detect such issue
The patch is going to fix this issue
Cc: Liming Gao <liming.gao@intel.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
---
BaseTools/Source/Python/Ecc/c.py | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/BaseTools/Source/Python/Ecc/c.py b/BaseTools/Source/Python/Ecc/c.py
index a30122a45f..e42463952d 100644
--- a/BaseTools/Source/Python/Ecc/c.py
+++ b/BaseTools/Source/Python/Ecc/c.py
@@ -2554,6 +2554,20 @@ def CheckGeneralDoxygenCommentLayout(Str, StartLine, ErrorMsgList, CommentId= -1
ErrorMsgList.append('Line %d : @retval appear before @param ' % StartLine)
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, @retval appear before @param ', TableName, CommentId)
+def CheckParamName(ParamName, Tag):
+ ParamList = Tag.split()
+ if len(ParamList) > 1:
+ ParamList.pop(0)
+ for Item in ParamList:
+ if Item.find('[') > 0 and Item.find(']') > 0:
+ continue
+ if ParamName != Item.strip():
+ return True
+ else:
+ return False
+ else:
+ return True
+
def CheckFunctionHeaderConsistentWithDoxygenComment(FuncModifier, FuncHeader, FuncStartLine, CommentStr, CommentStartLine, ErrorMsgList, CommentId= -1, TableName=''):
ParamList = GetParamList(FuncHeader) @@ -2608,7 +2622,7 @@ def CheckFunctionHeaderConsistentWithDoxygenComment(FuncModifier, FuncHeader, Fu
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT have %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'), TableName, CommentId)
- if Tag.find(ParamName) == -1 and ParamName != 'VOID' and ParamName != 'void':
+ if (Tag.find(ParamName) == -1 or CheckParamName(ParamName, Tag)) and ParamName != 'VOID' and ParamName != 'void':
ErrorMsgList.append('Line %d : in Comment, <%s> does NOT consistent with parameter name %s ' % (CommentStartLine, (TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName))
PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT consistent with parameter name %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName), TableName, CommentId)
Index += 1
--
2.14.1.windows.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-01-21 1:35 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-01-20 8:40 [PATCH] BaseTools:ECC fails to detect function header comments issue Fan, ZhijuX
2020-01-21 1:35 ` Bob Feng
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox