已关闭
[Documentation|文档反馈]: 对外头文件注释拼写错误 4 处(defalut/complie/occured/qurey) #969
dihidao创建于  14 天前关闭于  5 天前
dihidao
dihidao
14 天前 创建

场景:开发者使用 CANN runtime 的对外头文件(include/pkg_inc 随包发布)。

问题与位置(master 2026-09-12 核实):

  1. include/external/acl/error_codes/rt_error_codes.h:52:ACL_ERROR_RT_STREAM_CAPTURE_IMPLICIT 注释 "a disallowed implicit dependency from defalut stream" → default(对外公共 ACL 错误码头文件);
  2. pkg_inc/runtime/rt_external_preload.h:110,127:注释 "task info for complie" → compile(2 处);
  3. pkg_inc/aicpu_sched/aicpu_schedule/aicpusd_info.h:275:注释 "0:Exception occured, 1:Exception expired" → occurred;
  4. src/aicpu_sched/aicpu_schedule/core/aicpusd_drv_manager.h:93:注释 "it is used qurey buff group info" → query(buff 亦建议 buffer)。

影响:对外发布头文件随 SDK 分发,注释拼写错误直接影响开发者看到的接口文档质量。

问题复现方式:master 对应文件行号即见。
修复建议:按上述替换。已检索本仓 897 条历史 issues,未见报告。

likedislike
jiaxingru
jiaxingru成员
14 天前 评论:

/assign @m0_60337577

likedislike
CANN-robotCANN-robot成员
14 天前 将 m0_60337577 设为负责人
jiaxingru
jiaxingru成员
14 天前 评论:

你好,感谢反馈。经核实,master 分支中上述拼写问题均存在。

本问题涉及 4 类拼写问题,共 5 处注释,其中对外发布头文件 4 处、内部源码头文件 1 处。我们将按以下方式修正:

  • defalut 修改为 default
  • complie 相关表述调整为 task information for compilation
  • occured 修改为 occurred
  • qurey buff group info 调整为 query buffer group information

本次修改仅涉及英文注释,不改变接口定义、功能行为及 ABI。修复完成后将关联该 issue。

likedislike
jiaxingrujiaxingru成员
12 天前 关联了pull request:docs: 修复头文件及源码注释中的拼写错误(#969)
zhangjiezhangjie成员
12 天前 删除了关联的pull request:docs: 修复头文件及源码注释中的拼写错误(#969)
jiaxingru
jiaxingru成员
12 天前 评论:

你好,相关问题已修复并完成合入:

  • master 分支:PR #4893
  • 9.2.0 分支:PR #4914

本次共修复 6 个文件中的 12 处英文注释拼写问题。烦请确认,若无其他问题,请关闭该 Issue,感谢。

likedislike
jiaxingrujiaxingru成员
12 天前 添加了label:wait-feedback
CANN-robot
CANN-robot成员
5 天前 评论:

您好,为了更准确地定位和解决问题,我们需要您提供上述提到的相关信息。如果 14 天内没有进一步更新,我们将暂时关闭此 Issue。感谢您的理解与配合。

likedislike
dihidaodihidao
5 天前 issue状态由 进行中 改变为 已解决
dihidaodihidao
5 天前 关闭了 issue
CANN-robotCANN-robot成员
5 天前 添加了label:resolved