已关闭
修复 build.md 参数表格式错误并完善 --build-type、--cov、--valgrind 参数说明 #662
ayuemoon创建于  7月28日关闭于  7月31日
ayuemoon
ayuemoon
7月28日 创建

Backgroud(背景信息)

docs/zh/install/build.md 参数表中存在以下问题:

  1. --help, -h 参数名中误用了中文逗号 ,应为英文逗号 ,
  2. --build-type 描述不准确,原"启用调试模式"应为"指定构建类型",并补充用法示例
  3. --cov 参数说明标注为"预留参数",实际 build.sh 中该功能为单元测试代码覆盖率统计(lcov)
  4. --valgrind 参数说明标注为"预留参数",实际 build.sh 中已完整实现

Origin(信息来源)

PR #1191 自动分析

Benefit / Necessity(价值/作用)

  1. 修正参数表格式错误,避免用户复制参数名时出错
  2. 完善 --build-type 描述,更准确地反映参数功能
  3. 补充 --cov--valgrind 实际功能说明,减少开发者查阅源码的成本

Design(设计方案)

直接修改 docs/zh/install/build.md 参数表对应行

likedislike
ayuemoonayuemoon
7月28日 修改标题为 “修复 build.md 参数表格式错误并完善 --valgrind 参数说明”,原标题为“[Requirement|������] �޸� build.md �������ʽ�������� --valgrind ����˵��”
ayuemoonayuemoon
7月28日 修改了issue 的描述
liu-wei
liu-wei成员
7月28日 评论:

感谢您的反馈,文档中英文符号混用情况我们会尽快确认进行修改。

likedislike
liu-weiliu-wei成员
7月28日 将 ayuemoon 设为负责人
ayuemoonayuemoon
7月29日 修改标题为 “修复 build.md 参数表格式错误并完善 --build-type、--cov、--valgrind 参数说明”,原标题为“修复 build.md 参数表格式错误并完善 --valgrind 参数说明”
ayuemoonayuemoon
7月29日 修改了issue 的描述
ayuemoonayuemoon
7月29日 修改了issue 的描述
ayuemoonayuemoon
7月29日 修改了issue 的描述
ayuemoonayuemoon
7月29日 修改了issue 的描述
CANN-robotCANN-robot成员
7月31日 关闭了 issue
CANN-robotCANN-robot成员
7月31日 添加了label:resolved