中文
注册
我要评分
文档获取效率
文档正确性
内容完整性
文档易理解
在线提单
论坛求助

构建亲和命令参考

构建亲和功能用于分析Makefile、CMakeLists.txt中可以替换鲲鹏加速库的内容,并提供替换建议和功能修复。

命令功能

对构建亲和进行检查。

命令格式

devkit advisor affi-check {-i INPUT_PATH | --input INPUT_PATH} {-c COMMAND | --cmd COMMAND} [-o OUTPUT_PATH | --output OUTPUT_PATH] [-b {make,cmake} | --build-tool {make,cmake}] [-r {all,json,html,csv} | --report-type {all,json,html,csv}] [-l {0,1,2,3} | --log-level {0,1,2,3}] [--set-timeout TIMEOUT]

参数说明

表1 参数说明

参数

参数选项

参数说明

-i/--input

-

对应的源码文件夹路径。

-c/--cmd

-

源码的构建命令。

-o/--output

-

扫描报告的存放地址和文件名称。

-b/--build-tool

make/cmake

构建工具,默认为make。

--set-timeout

-

任务超时时间,单位为分钟,若执行时间超过超时时间则退出执行。默认无超时时间,任务将持续执行直到结束。

-l/--log-level

0/1/2/3

设置日志级别,默认为1。

  • 0:日志级别为DEBUG。
  • 1:日志级别为INFO。
  • 2:日志级别为WARNING。
  • 3:日志级别为ERROR。

-r/--report-type

all/json/html/csv

扫描报告的格式,默认为all。

  • all:生成JSON、HTML、CSV三种格式报告。
  • json:生成JSON格式报告。
  • html:生成HTML格式报告。
  • csv:生成CSV格式报告。

使用示例

此处以扫描“/opt/testcase/affinity/build/wtdbg2-2.5”路径下源码,构建命令为make并输出所有格式报告为例,请根据实际情况替换成实际需要扫描的配置文件路径。

devkit advisor affi-check -i /opt/testcase/affinity/build/wtdbg2-2.5 -c 'make' -r all
返回信息如下,并输出报告。
Build Affinity Affinity task has been executed.
Scanned time: 2024/03/21 06:11:08
Scan status: Succeed. Some items are recommended to be modified.

Configuration:
     Source code file path: /opt/testcase/affinity/build/wtdbg2-2.5
     Log level: info
     Report type: all
     Timeout interval setting: The timeout period is not set.

Summary: 
      2 dependency files can be accelerated. There are 1 recommended modifications, 1 lines of code need to be modified.

For the detailed information, please check:
     /home/build_source/affinity/affi-check_20240321061108_ef0a.json
     /home/build_source/affinity/affi-check_20240321061108_ef0a.html
     /home/build_source/affinity/affi-check_20240321061108_ef0a.csv

输出报告说明

表2 构建亲和输出报告参数说明

参数

说明

配置信息

显示软件源码文件存放路径。

需要修改的源码文件

显示需要存在构建亲和需要进行修改的源码文件路径等相关信息。