已开启
[Documentation|文档反馈]: 开发验证包头文件范围说明不准确 #41
KaranocaVe创建于  15 天前
KaranocaVe
KaranocaVe
15 天前 创建

[Documentation|文档反馈]: 开发验证包头文件范围说明不准确

文档链接

https://gitcode.com/cann/asc-comm/blob/master/README.md#L46

问题片段

build.sh --pkg,仅 aicore 头,不含 SO

存在的问题

制包脚本递归收集 include/ 和 src/ 下的 .h 文件。Hcomm 头文件安装到 adv_api,其余头文件按相对路径安装到 comm_api。因此当前说明会让读者误以为包不含 Ain、CCU 等非 Hcomm 头文件。

复现条件

  • 仓库:cann/asc-comm
  • 固定提交:da9a333363207ab65746fd6dd6eb80cafde25691
  • 构建入口:bash build.sh --pkg

该提交中参与扫描的头文件共 150 个:Hcomm 路径 27 个,其他 include/ 和 src/ 路径 123 个。制包实现将 Hcomm 头文件放入 adv_api,并将其余头文件放入 comm_api;包测试断言 ccu/ccu_host_launch.h 会出现在 comm_api 中。

预期与实际

README 应准确说明开发验证包包含 include/ 和 src/ 中的头文件。当前说明将范围缩小为 AICore 头文件,与制包实现和包测试不符。

影响与修复

读者可能错误判断 Ain、CCU 等头文件不在开发验证包中。仅修正文档范围说明,不改变制包行为:说明递归收集 include/ 和 src/ 中的 .h 文件,并保留“不含 SO”的信息。

Validation

验证

固定复现提交:da9a333363207ab65746fd6dd6eb80cafde25691。

实现与文档对照

  • README.md 的交付说明将 build.sh --pkg 写成仅包含 AICore 头文件。
  • 同页其他说明及中文构建指南描述了 include/、src/ 中头文件的收集和安装位置。
  • scripts/package/build_package.sh 将 Hcomm 头文件复制到 adv_api,并将其余 include/、src/ 头文件复制到 comm_api。
  • tests/package/test_run_package.sh 统计相同的四组头文件,并断言 asc/include/comm_api/ccu/ccu_host_launch.h 存在。

固定提交中的扫描范围共 150 个 .h 文件:Hcomm 路径 27 个,其他 include/ 和 src/ 路径 123 个。

检查结果

  • bash -n scripts/package/build_package.sh:通过。
  • 对照实现和包测试中的收集映射:通过。
  • git diff --check:README 修改无空白错误。
  • pre-commit 4.6.2 对 README.md:codespell、OAT 合规和 Markdown 链接检查通过;C++、Python 和 YAML 检查因文件类型不适用而跳过。
  • 完整制包测试:未运行;本次修复只调整 README,验证依据为制包逻辑和测试断言。

上游当前 head

  • Issue:https://gitcode.com/cann/asc-comm/issues/41
  • PR:https://gitcode.com/cann/asc-comm/merge_requests/228
  • 当前 head:b3fb4023deb5456539e50439f0b7f1fd5b8f2d14,base 为 master。
  • ci-pipeline-passed 已绑定当前 head;PR 非 draft、无冲突、依赖和非快进门禁通过。
  • 当前 PR 评论未见未解决技术讨论;模块级 lgtm/approve 尚未满足,当前账号没有 PUSH 合并权限,等待维护者审批和合入。

关联 PR: https://gitcode.com/cann/asc-comm/merge_requests/228

likedislike
KaranocaVeKaranocaVe
15 天前 关联了pull request:docs: 修正开发验证包头文件范围说明
KaranocaVeKaranocaVe
15 天前 修改了issue 的描述
KaranocaVe
KaranocaVe
12 天前 评论:

/assign

likedislike
CANN-robotCANN-robot成员
12 天前 将 KaranocaVe 设为负责人
KaranocaVeKaranocaVe
10 天前 修改了issue 的描述