Pull Request已成功合入, 合并人@CANN-robot
(感谢 lihuaichao 的贡献)变更摘要
本 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缓存一致性相关的约束条目不变。


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
/approveor/lgtm- Commenting
/approveimplies 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. 👍


compile


| 🚀 CI 流水线已启动 |
|---|
| 📋 执行详情: 点击查看流水线 |


compile


| 🚀 CI 流水线已启动 |
|---|
| 📋 执行详情: 点击查看流水线 |


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.


描述
统一
asc_atomic_max、asc_atomic_min、asc_atomic_or、asc_atomic_sub和asc_atomic_xor文档的参数描述、流水类型章节及约束说明,删除与功能说明重复的内容,提升同类 C API 文档的一致性。关联的Issue
无。
测试
git diff --check,检查通过。文档更新
更新
docs/zh/api/SIMD-API/c_api/atomic/scalar_atomic/下 5 个标量原子接口文档。类型标签