Merged
docs: complete quick-start unit test groups #7091
docs: complete quick-start unit test groups #7091
Merged
aodebiaoAdd on 24 days ago
aodebiao
aodebiao
24 days ago

Description

Motivation

The quick-start guides list only four of the eight supported unit-test groups, leaving out the second advanced group, basic groups four/five and the ARM group.

Changes

  • Add the four missing groups to the online and offline examples in both guides.
  • Align the new group comments with the existing examples.

Closes #1947

Testing

  • Ran bash build.sh --help; exit 0.
  • Checked both guides' online and offline commands against all eight group arrays in tests/test_parts.sh and the CLI help.
  • Repository pre-commit passed for the two changed guides, including the Markdown link checker (four files checked with linked documents).
  • Command lines are unchanged by this review revision. No UT build or NPU run was performed.

Documentation Updates

Updated docs/en/quick_start.md and docs/zh/quick_start.md only.

Type Labels

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for aodebiao's contribution.)
aodebiaoaodebiao
24 days ago Created pull request, commit 1a1e934f
aodebiaoaodebiao
24 days ago Associated issue: [Documentation|文档反馈]: 快速入门遗漏多个 UT 测试分组
atomgit-bot
atomgit-bot
24 days ago Comments:

变更摘要

本 PR 为文档更新,目的是补齐快速入门指南中缺失的单元测试分组命令,使文档列出的命令与 build.sh 实际支持的选项保持一致。改动同时覆盖中文(docs/zh/quick_start.md)和英文(docs/en/quick_start.md)两份指南的「UT执行」章节:新增全量测试入口 bash build.sh --test 的说明,并在在线与离线两种执行方式的示例中补充 --adv_test_two、--basic_test_four、--basic_test_five、--arm_test 四个分组命令。

主要改动

  • 新增全量测试入口说明: 将方式一的描述从「按模块顺序批跑 tests 目录」改为先介绍在仓库根目录运行 bash build.sh --test 执行全部单元测试,再说明可按需选择分组命令并通过结果日志查看编译状态。
  • 补充高级测试分组: 在在线与离线示例中均新增 bash build.sh --adv_test_two,用于批跑 adv_api 的第二组用例。
  • 补充基础测试分组: 在两种示例中新增 bash build.sh --basic_test_four 与 bash build.sh --basic_test_five,覆盖 basic_api 的第四、第五组用例。
  • 补充 ARM 测试分组: 在两种示例中新增 bash build.sh --arm_test,用于批跑 arm_test 分组用例。
  • 中英文档同步更新: 中文与英文指南对 --test、--adv_test_two、--basic_test_four、--basic_test_five、--arm_test 的描述与命令保持一致,离线示例同样附加 --cann_3rd_lib_path={PATH_TO_DOWNLOAD} 参数。
likedislike
Incorrect?
atomgit-bot
atomgit-bot
24 days ago Comments:

代码审查

✅ 未发现问题

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
24 days ago Added label: cann-cla/yes
82 messages are collapsed here。 See more
maohp_hwmaohp_hwCollaborators
12 days ago Resolved final issue
bianque
bianqueCollaborators
12 days ago Comments:

/lgtm

likedislike
munanhw
munanhwCollaborators
12 days ago Comments:

/approve

likedislike
CANN-robotCANN-robotCollaborators
12 days ago Added label: lgtmapproved
CANN-robotCANN-robotCollaborators
12 days ago Merged pull request