Merge remote-tracking branch 'origin/main'

Author: bensonhome

doc/.vuepress/configs/sidebar/en.ts

@@ -30,7 +30,6 @@ export const en: SidebarConfig = {
             '/en/guide/代码检查/工具/TCA-Armory-R.md',
             '/en/guide/代码检查/工具/TCA-Armory-C1.md',
             '/en/guide/代码检查/工具/TCA-Armory-Q1.md',
-            '/en/guide/代码检查/工具/cppcheck.md',
             '/en/guide/代码检查/工具/Error-Prone.md',
           ],
         },

doc/.vuepress/configs/sidebar/zh.ts

@@ -30,7 +30,6 @@ export const zh: SidebarConfig = {
             '/zh/guide/代码检查/工具/TCA-Armory-R.md',
             '/zh/guide/代码检查/工具/TCA-Armory-C1.md',
             '/zh/guide/代码检查/工具/TCA-Armory-Q1.md',
-            '/zh/guide/代码检查/工具/cppcheck.md',
             '/zh/guide/代码检查/工具/Error-Prone.md',
           ],
         },

doc/en/guide/客户端/本地分析.md

@@ -28,6 +28,10 @@
 - 安装依赖：`pip3 install -r CodeAnalysis/client/requirements/app_reqs.pip`
 
 **4. 安装第三方工具（docker下启动分析可跳过）**
+- 在命令行(windows环境下可以启动`git bash`)中执行以下命令：
+```bash
+bash ./scripts/base/install_bin.sh
+```
 - 进入到`client/requirements`目录
 - 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat`(windows环境)
 

doc/en/quickStarted/enhanceDeploy.md

@@ -85,35 +85,19 @@ Different deployment methods can modify the `config.ini` configuration according
   - Restart the container method: `docker-compose restart client`
 :::
 
-3. Apply for a License by email to the TCA team
-
-- Recipient email:
-```
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-```
-
-- The application email format is as follows:
-
-Subject: **TCA Independent Tool License Application**
-
-Content:
-| | | 
-|  :----:  | :----:  |
-| Applicant's Name  | xxx |
-| Name of the Organization the Applicant Belongs to | xxx |
-| Type of Organization the Applicant Belongs to | Optional: Company/School/Individual |
-| Applicant's Email | xxx |
-| Applicant's Mobile Number | xxx |
-| Is it Privately Deployed | Yes |
-| First Registered Machine Code | xxx |
-| Purpose of Experience Application | xxx |
-| Client License | xxx |
-
-- `First Registered Machine Code`: The `Server ID` output in step one
-- `Client License`: The `Client License` output in step one
+3. Submit a private cloud license application on the TCA Cloud official website
+- (1) Register or log in to an account on the [TCA Cloud official website](https://tca.tencent.com/);
+- (2) Enter the team that needs to apply for a private cloud license (if there is no team, you need to create a corresponding team);
+- (3) On the team page, enter the [Node Management]->[Private Cloud License Configuration] page in turn, then click the [Apply for License] button in the upper right corner, fill in the relevant information and submit the application. The specific information is as follows:
+  - Applicant name
+  - Applicant's organization name
+  - Applicant's organization type: company/university/individual
+  - Applicant's email address
+  - Applicant's mobile phone number
+  - Server ID: `Server ID` output in step 1, the machine code for the first registration
+  - Client License: `Client License` output in step 1
+  - Application scenario
+- (4) Then wait for the application license to be reviewed and approved, you can copy the private cloud license and continue with the following step 4.
 
 4. After receiving the reply email from the TCA team, fill in the License in the `config.yaml` file in the CLS directory  
 

doc/zh/api/代码度量数据模块接口.md

@@ -10,20 +10,20 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| state | str | 问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| scan_open | int | 发现问题的扫描编号 |
-| scan_close | int | 修复问题的扫描编号 |
-| worse | boolean | 圈复杂度是否恶化 |
-| over_cc_sum_gte | int | 圈复杂度总和最小值 |
-| over_cc_sum_lte | int | 圈复杂度总和最大值 |
-| over_cc_avg_gte | int | 平均圈复杂度最小值 |
-| over_cc_avg_lte | int | 平均圈复杂度总和最大值 |
-| over_cc_func_count_gte | int | 超标圈复杂度函数个数最小值 |
-| over_cc_func_count_lte | int | 超标圈复杂度函数个数最大值 |
+| state | str | 选填，问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| scan_open | int | 选填，发现问题的扫描编号 |
+| scan_close | int | 选填，修复问题的扫描编号 |
+| worse | boolean | 选填，圈复杂度是否恶化 |
+| over_cc_sum_gte | int |选填， 圈复杂度总和最小值 |
+| over_cc_sum_lte | int | 选填，圈复杂度总和最大值 |
+| over_cc_avg_gte | int | 选填，平均圈复杂度最小值 |
+| over_cc_avg_lte | int | 选填，平均圈复杂度总和最大值 |
+| over_cc_func_count_gte | int | 选填，超标圈复杂度函数个数最小值 |
+| over_cc_func_count_lte | int | 选填，超标圈复杂度函数个数最大值 |
 
 #### 返回参数
 
@@ -84,13 +84,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| status | str | 问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| ccn_gte | str | 圈复杂度最小值 |
-| ccn_lte | str | 圈复杂度最大值 |
+| status | str | 选填，问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| ccn_gte | str | 选填，圈复杂度最小值 |
+| ccn_lte | str | 选填，圈复杂度最大值 |
 
 #### 返回结果
 
@@ -151,13 +151,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| status | str | 问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| ccn_gte | str | 圈复杂度最小值 |
-| ccn_lte | str | 圈复杂度最大值 |
+| status | str | 选填，问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| ccn_gte | str | 选填，圈复杂度最小值 |
+| ccn_lte | str | 选填，圈复杂度最大值 |
 
 #### 返回结果
 
@@ -218,20 +218,20 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| state | str | 问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| scan_open_id | int | 发现问题的扫描编号 |
-| scan_close_id | int | 修复问题的扫描编号 |
-| worse | boolean | 圈复杂度是否恶化 |
-| over_cc_sum_gte | int | 圈复杂度总和最小值 |
-| over_cc_sum_lte | int | 圈复杂度总和最大值 |
-| over_cc_avg_gte | int | 平均圈复杂度最小值 |
-| over_cc_avg_lte | int | 平均圈复杂度总和最大值 |
-| over_cc_func_count_gte | int | 超标圈复杂度函数个数最小值 |
-| over_cc_func_count_lte | int | 超标圈复杂度函数个数最大值 |
+| state | str | 选填，问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| scan_open_id | int | 选填，发现问题的扫描编号 |
+| scan_close_id | int | 选填，修复问题的扫描编号 |
+| worse | boolean | 选填，圈复杂度是否恶化 |
+| over_cc_sum_gte | int | 选填，圈复杂度总和最小值 |
+| over_cc_sum_lte | int | 选填，圈复杂度总和最大值 |
+| over_cc_avg_gte | int | 选填，平均圈复杂度最小值 |
+| over_cc_avg_lte | int | 选填，平均圈复杂度总和最大值 |
+| over_cc_func_count_gte | int | 选填，超标圈复杂度函数个数最小值 |
+| over_cc_func_count_lte | int | 选填，超标圈复杂度函数个数最大值 |
 
 #### 返回结果
 
@@ -295,13 +295,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| status | str | 问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| ccn_gte | str | 圈复杂度最小值 |
-| ccn_lte | str | 圈复杂度最大值 |
+| status | str | 选填，问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| ccn_gte | str | 选填，圈复杂度最小值 |
+| ccn_lte | str | 选填，圈复杂度最大值 |
 
 #### 返回结果
 
@@ -362,13 +362,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| status | str | 问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
-| change_type | str | 圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
-| author | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| ccn_gte | str | 圈复杂度最小值 |
-| ccn_lte | str | 圈复杂度最大值 |
+| status | str | 选填，问题状态，1为需要关注，2为无需关注，可多选，格式为1,2,3 |
+| change_type | str | 选填，圈复杂度变化情况，0为无，1为新增，2为删除，3为无变化，可多选，格式为1,2,3 |
+| author | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| ccn_gte | str | 选填，圈复杂度最小值 |
+| ccn_lte | str | 选填，圈复杂度最大值 |
 
 #### 返回结果
 
@@ -429,13 +429,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| issue__state | str | 问题状态, 1为未处理，2为可忽略，3为关闭，可多选，格式为1,2,3 |
-| change_type | str | 重复文件更改类型，add为新增，del为删除，mod为删除，可多选，格式为add,del,mod |
-| issue__owner | str | 问题责任人 |
-| last_modifier | str | 最近修改人 |
-| file_path | str | 文件路径 |
-| duplicate_rate_gte | int | 重复率最小值 |
-| duplicate_rate_lte | int | 重复率最大值 |
+| issue__state | str | 选填，问题状态, 1为未处理，2为可忽略，3为关闭，可多选，格式为1,2,3 |
+| change_type | str | 选填，重复文件更改类型，add为新增，del为删除，mod为删除，可多选，格式为add,del,mod |
+| issue__owner | str | 选填，问题责任人 |
+| last_modifier | str | 选填，最近修改人 |
+| file_path | str | 选填，文件路径 |
+| duplicate_rate_gte | int | 选填，重复率最小值 |
+| duplicate_rate_lte | int | 选填，重复率最大值 |
 
 #### 返回结果
 
@@ -590,8 +590,8 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| change_type | str | 改变类型（add、mod、del），支持多值，使用英文逗号','分隔 |
-| file_path | str | 文件路径 |
+| change_type | str | 选填，改变类型（add、mod、del），支持多值，使用英文逗号','分隔 |
+| file_path | str | 选填，文件路径 |
 
 #### 返回结果
 

doc/zh/api/代码扫描数据模块接口.md

@@ -9,17 +9,17 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 #### 参数
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| state | str | 问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
-| severity | str | 严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
-| resolution | str | 解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
-| author | str | 问题责任人 |
-| scan_open | int | 发现问题的扫描编号 |
-| scan_fix | int | 修复问题的扫描编号 |
-| ci_time_gte | str | 修复问题的起始时间，格式为"2021-01-01 00:00:00" |
-| ci_time_lte | str | 修复问题的结束时间 |
-| file_path | str | 文件路径 |
-| checkrule_display_name | str | 检查规则名 |
-| checkpackage | int | 问题所属的规则包 |
+| state | str | 选填，问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
+| severity | str | 选填，严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
+| resolution | str | 选填，解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
+| author | str | 选填，问题责任人 |
+| scan_open | int | 选填，发现问题的扫描编号 |
+| scan_fix | int | 选填，修复问题的扫描编号 |
+| ci_time_gte | str | 选填，修复问题的起始时间，格式为"2021-01-01 00:00:00" |
+| ci_time_lte | str | 选填，修复问题的结束时间 |
+| file_path | str | 选填，文件路径 |
+| checkrule_display_name | str | 选填，检查规则名 |
+| checkpackage | int | 选填，问题所属的规则包 |
 
 #### 返回结果
 ```JSON
@@ -143,17 +143,17 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 #### 参数
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| state | str | 问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
-| severity | str | 严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
-| resolution | str | 解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
-| author | str | 问题责任人 |
-| scan_open_id | int | 发现问题的扫描编号 |
-| scan_fix_id | int | 修复问题的扫描编号 |
-| ci_time_gte | str | 修复问题的起始时间 |
-| ci_time_lte | str | 修复问题的结束时间 |
-| file_path | str | 文件路径 |
-| checkrule_display_name | str | 检查规则名 |
-| checkpackage | int | 问题所属的规则包 |
+| state | str | 选填，问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
+| severity | str | 选填，严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
+| resolution | str | 选填，解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
+| author | str | 选填，问题责任人 |
+| scan_open_id | int | 选填，发现问题的扫描编号 |
+| scan_fix_id | int | 选填，修复问题的扫描编号 |
+| ci_time_gte | str | 选填，修复问题的起始时间 |
+| ci_time_lte | str | 选填，修复问题的结束时间 |
+| file_path | str | 选填，文件路径 |
+| checkrule_display_name | str | 选填，检查规则名 |
+| checkpackage | int | 选填，问题所属的规则包 |
 
 #### 返回结果
 ```JSON
@@ -212,17 +212,17 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 #### 参数
 | 参数 | 类型 | 描述 |
 | --- | --- | --- |
-| state | str | 问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
-| severity | str | 严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
-| resolution | str | 解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
-| author | str | 问题责任人 |
-| scan_open_id | int | 发现问题的扫描编号 |
-| scan_fix_id | int | 修复问题的扫描编号 |
-| ci_time_gte | str | 修复问题的起始时间 |
-| ci_time_lte | str | 修复问题的结束时间 |
-| file_path | str | 文件路径 |
-| checkrule_display_name | str | 检查规则名 |
-| checkpackage | int | 问题所属的规则包 |
+| state | str | 选填，问题状态, 1为未处理，2为已处理，3为关闭，可多选，格式为1,2,3 |
+| severity | str | 选填，严重程度, 1为致命，2为错误，3为警告，4为提示，可多选，格式为1,2,3,4 |
+| resolution | str | 选填，解决方式, 0为无，1为修复，2为无需修复，3为误报，4为重复单过滤，5为路径过滤，6为规则移除 |
+| author | str | 选填，问题责任人 |
+| scan_open_id | int | 选填，发现问题的扫描编号 |
+| scan_fix_id | int | 选填，修复问题的扫描编号 |
+| ci_time_gte | str | 选填，修复问题的起始时间 |
+| ci_time_lte | str | 选填，修复问题的结束时间 |
+| file_path | str | 选填，文件路径 |
+| checkrule_display_name | str | 选填，检查规则名 |
+| checkpackage | int | 选填，问题所属的规则包 |
 
 #### 返回结果
 ```JSON
@@ -271,4 +271,4 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
     "msg": "xxx",
     "status_code": 200
 }
-```
+```