Skip to content

Commit 0e9801e

Browse files
authored
Merge pull request #611 from bensonhome/main
🎨delete redundant comment
2 parents e696bdf + ccf6c88 commit 0e9801e

8 files changed

Lines changed: 9 additions & 14 deletions
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

client/task/sourcemgr.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,12 +262,6 @@ def __init__(self, params, task_type, tool, inc_src):
262262
self.enable_lfs = True
263263

264264
def load_source_dir(self):
265-
"""
266-
1. 普通项目,正常拉代码正常使用缓存
267-
2. 本地项目,传入本地代码路径
268-
3. qci项目,传入本地项目,coverity等工具需要scm.clean
269-
4. 本地项目,传项目ID的情况,没有传sourecedir,也是要拉代码的
270-
"""
271265
logger.info("start __checkout_source_dir.")
272266
if self.params["task_scene"] == TaskScene.LOCAL:
273267
if "source_dir" in self.params:

client/task/taskmgr.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,4 @@ def get_tool_version(self):
144144

145145

146146
if __name__ == '__main__':
147-
print(TaskMgr.get_private_processes('coverity_java'))
147+
pass

client/task/toolmodel.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ def set_inc_source_path_list(self):
109109
'''
110110
用于设置该工具使用增量资源的缓存目录
111111
默认只增量缓存'source_dir'
112-
coverity会需要缓存'source_dir','work_dir'
112+
部分工具会需要缓存'source_dir','work_dir'
113113
:return: 需要缓存的目录名
114114
'''
115115
return ['source_dir'] # 考虑试用setting里面的字段
@@ -118,7 +118,7 @@ def set_inc_source_type(self):
118118
'''
119119
用于设置增量资源的类型,当不同工具需要使用同一个增量资源时直接默认使用Normal
120120
例如androidlint与findbugs可以复用
121-
coverity会需要单独使用一个增量资源,因此单独创建一个类型出来
121+
部分工具会需要单独使用一个增量资源,因此单独创建一个类型出来
122122
:return: 增量资源类型,一般直接使用工具名即可
123123
'''
124124
return 'normal'
@@ -156,7 +156,7 @@ def set_issue_ignore_type(self):
156156
def set_mid_source_path_list(self):
157157
'''
158158
区别于增量资源的管理,编译与分析task之间的数据传递也需要控制
159-
例如:coverity编译后传递的是idir中的中间文件,但不排除某些工具需要编译过后的项目代码文件
159+
例如:编译后传递的是idir中的中间文件,但不排除某些工具需要编译过后的项目代码文件
160160
因此这里暂时默认将workdir作为需要传递的中间文件
161161
:return:
162162
'''
@@ -173,7 +173,7 @@ def set_add_file_info(self):
173173
def set_tool_skip_condition(self, params):
174174
'''
175175
用于实现判断条件,跳过本次工具扫描。
176-
适用场景:例如当coverity扫描前,判断项目变更内容中无代码文件
176+
适用场景:例如当工具扫描前,判断项目变更内容中无代码文件
177177
:return:
178178
'''
179179
return False
@@ -196,9 +196,6 @@ def set_add_person_info(self):
196196
def check_tool_usable(self, tool_params):
197197
'''
198198
检查工具是否可以用,具体检查内容:
199-
1. 工具执行所需哪些环节
200-
2. 各环节中对环境变量的依赖与本地工具的依赖
201-
3. 工具执行的必要条件,如coverity执行分析需要license文件
202199
注意:此部分只检查compile与analyze等工具所属的步骤,datahandle不属于此部分
203200
:return:支持该工具的task类型数组,若不支持返回空数组
204201
'''

doc/zh/guide/工具管理/自定义工具.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@
125125

126126
- **是否为编译型工具**,表示在使用该工具对用户代码进行分析时,是否要求代码需要编译或可执行编译
127127

128+
- **注意**:针对特殊扫描场景的工具(比如检查代码库下是否包含某些第三方依赖目录,结果不涉及单个代码文件的),无法对结果进行代码文件处理,可以通过设置以下环境变量,跳过一些通用的结果处理步骤,避免问题结果被过滤掉:
129+
- `BLAME_TYPE=NO_BLAME`,跳过对代码行/代码文件进行文件责任人定位(结果非单个文件/代码行时使用)
130+
- `FILTER_TYPE=NO_VERSION_FILTER`,跳过检查问题路径(path字段)是否为已提交到代码库中的文件(结果非单个文件/代码行时使用)
131+
- `IGNORE_TYPE=NO_ISSUE_IGNORE`,跳过注释忽略处理(结果非单个文件/代码行时使用)
128132

129133
- 添加工具依赖
130134

0 commit comments

Comments
 (0)