已合并
docs: 统一标量原子接口文档描述 #6753
docs: 统一标量原子接口文档描述 #6753
已合并
lihuaichao创建于 15 天前
lihuaichao成员
15 天前

描述

统一 asc_atomic_max、asc_atomic_min、asc_atomic_or、asc_atomic_sub 和 asc_atomic_xor 文档的参数描述、流水类型章节及约束说明,删除与功能说明重复的内容,提升同类 C API 文档的一致性。

关联的Issue

无。

测试

  • 执行 git diff --check,检查通过。
  • 核对 5 个接口的文档结构,均包含产品支持情况、功能说明、函数原型、参数说明、返回值说明、流水类型、约束说明和调用示例。
  • 核对相对链接及芯片过滤标签,未发现问题。

文档更新

更新 docs/zh/api/SIMD-API/c_api/atomic/scalar_atomic/ 下 5 个标量原子接口文档。

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 lihuaichao 的贡献)
Llihuaichao成员
15 天前 创建了 pull request,commit daca4af6
atomgit-bot
atomgit-bot
15 天前 评论:

变更摘要

本 PR 对标量原子接口文档进行统一整理,涉及 asc_atomic_max、asc_atomic_min、asc_atomic_or、asc_atomic_sub、asc_atomic_xor 五个标量原子操作接口的文档(asc_atomic_*.md)。改动不涉及业务逻辑,仅调整文档描述:将参数表中的 address 由「输入/输出」改为「输入」,新增「流水类型」章节并标注 PIPE_S,同时删减了原有的部分约束说明。

主要改动

  • 统一参数方向描述: 五个接口文档的参数说明表中,address 的「输入/输出」列统一修正为「输入」,仅 val 保持为「输入」。
  • 新增流水类型章节: 在「返回值说明」之后新增 ## 流水类型 章节,标注接口运行于 PIPE_S 标量流水。
  • 删除地址空间与对齐约束: 移除「address必须落在Global Memory地址空间」和「address需按sizeof(dtype)字节对齐」两条约束说明。
  • 删除并发原子性说明: 移除各接口关于同一 address 并发调用以原子方式完成读写、不丢失更新的描述,其中 asc_atomic_max、asc_atomic_min、asc_atomic_or、asc_atomic_xor 描述最终结果,asc_atomic_sub 额外提及 float 类型下结果可能因执行顺序不同而存在差异。
  • 保留同步与缓存一致性约束: 保留关于跨流水同步(asc_sync_pipe、asc_sync_notify、asc_sync_wait)以及绕过 DCache、asc_dcci 缓存一致性相关的约束条目不变。
likedislike
不准确?
atomgit-bot
atomgit-bot
15 天前 评论:

代码审查

✅ 未发现问题

likedislike
不准确?
CANN-robotCANN-robot成员
15 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
15 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
docs ✅ munanhw, Lycheeeee (2/2) ✅ munanhw (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

lihuaichao, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
15 天前 评论:

CLA Signature Pass

lihuaichao, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
15 天前 将zengjuan,zhanghao_0689,suqwe,wulinyu,kong0808,dengjing_aoe,YeZZzzz1,bluesky901,yangbinhua,zhudi22,chenyiyuan,xun_zhuge,XuebinYang,sjtulxh,bianque,houyuyang,Lycheeeee,YANXI_ZHAO,chentianyu19,shi_nanxiang,wuyang_hw,jiangxinyu3,munanhw,ai_xin,ascendhjh,hujiawen_kaven,wangxiaozhi,DragonBornHD84,louyuxuan,hyolee,yukangchen设为评审人
CANN-robotCANN-robot成员
15 天前 将bianque,munanhw,ai_xin,ascendhjh设为审查人
Llihuaichao成员
15 天前 修改了pull request 的描述
lihuaichao成员
15 天前 评论:

compile

likedislike
Llihuaichao成员
15 天前 预合并成功(commit_id: de2a9577350e518e834504472042e9ca67ddf18e)
CANN-robot
CANN-robot成员
15 天前 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
15 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
15 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
15 天前 添加了label:ci-pipeline-passed
Lycheeeee成员15 天前进行代码检视2
docs/zh/api/SIMD-API/c_api/atomic/scalar_atomic/asc_atomic_max.md
已过期
@@ -62,3 +62,3 @@
6262| 参数名 | 输入/输出 | 描述 |
6363| --- | --- | --- |
64-| address | 输入/输出 | Global Memory的地址。 |
64+| address | 输入 | Global Memory的地址。 |
Lycheeeee15 天前评论:

地址不修改,里面的值会作为输出。

likedislike
System
系统消息系统
15 天前 评论:

changed this line on f544c318 view diff detail

Llihuaichao成员
15 天前 预合并成功(commit_id: fc8da992ab3955b41422147b4808204d0c123012)
此处折叠了5条事件消息 查看更多
CANN-robotCANN-robot成员
15 天前 删除了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
15 天前 评论:

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): ci-pipeline-passed.

likedislike
munanhw成员
15 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
15 天前 添加了label:approved
lihuaichao成员
15 天前 评论:

compile

likedislike
Llihuaichao成员
15 天前 预合并成功(commit_id: d36330143c378bca77cae5e8ea22289848ee7976)
CANN-robot
CANN-robot成员
15 天前 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
15 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
15 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
15 天前 添加了label:ci-pipeline-passed
Lycheeeee成员
15 天前 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
15 天前 添加了label:lgtm
CANN-robot
CANN-robot成员
15 天前 评论:

The MR can not be merged, because of CodeReview discussion not resolved

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike
Llihuaichao成员
15 天前 解决了最后一个问题
CANN-robotCANN-robot成员
15 天前 合入了pull request