Closed
aclrtMemcpy2d 文档将行间距误写为列间距 #1144
KaranocaVeAdd on  20 days agoClosed at  16 days ago
KaranocaVe
KaranocaVe
20 days ago Create

aclrtMemcpy2d 文档将行间距误写为列间距

现象

固定源码 cann/runtime@c06e4cccb34ae5c5b616544250718879927da0d7 的两份中文 API 文档均将 aclrtMemcpy2d、aclrtMemcpy2dAsync 的 dpitch 和 spitch 解释为相邻两列向量的地址距离。该说明会让调用者按列间距计算二维缓冲区步长,和仓内示例实际使用方式不符。

源码与测试证据

  • docs/zh/api_ref/11-03_memory_copy_and_set.md 的同步、异步接口参数表,以及 docs/zh/api_ref/26_cpp_extension_APIs.md 的对应 C++ 接口参数表,都重复了该定义。
  • example/6_scenarios/image_processing/1_pitched_image_shift/pitched_image_shift.cpp 以 pitchElements * sizeof(uint16_t) 计算 pitch,使用 row * pitchElements + column 访问缓冲区,并将 kHeight 作为 aclrtMemcpy2d 的 height 传入;这表明 pitch 是相邻行数据的地址间距。
  • tests/ut/acl/testcase/acl_runtime_unittest.cpp 的 aclrtMemcpy2dTest 及零尺寸用例覆盖 2D API 的宽度与 pitch 校验、height 参数和接口调用路径。实现中的 CheckMemcpy2dParam 也要求 width 不大于 spitch、dpitch,与按行存放的数据宽度和行步长相符。

修复范围

将两份中文 API 文档中四组 dpitch、spitch 说明统一改为“相邻两行数据的地址距离”。该修改只纠正文档术语,不改变接口实现或行为。

关联 PR: https://gitcode.com/cann/runtime/merge_requests/5627

likedislike
KaranocaVeKaranocaVe
20 days ago Associated pull request
KaranocaVeKaranocaVe
20 days ago Modify description of issue
likeA_starlikeA_starCollaborators
20 days ago Assign yongfei-hu as responsible person
likeA_star
likeA_starCollaborators
20 days ago Comments:

感谢反馈,我们会尽快修改

likedislike
likeA_starlikeA_starCollaborators
16 days ago Associated pull request
likeA_star
likeA_starCollaborators
16 days ago Comments:

已合入

likedislike
likeA_starlikeA_starCollaborators
16 days ago changed custom state from 进行中 to 已完成
likeA_starlikeA_starCollaborators
16 days ago Close issue