已合并
docs下基本概念文件名从中文改为英文 #1151
chenjiao创建于 22 天前
docs下基本概念文件名从中文改为英文 #1151
已合并
chenjiao创建于 22 天前
chenjiao成员
22 天前

描述

docs目录基本概念md文件名改为英文:
避免link中的中文字符引发的跳转异常,例如两段式接口.md变成%E4%B8%A4%E6%AE%B5%E5%BC%8F%E6%8E%A5%E5%8F%A3.md,不易于维护,可能导致其他平台跳转有问题。

关联的Issue

#634

测试

ok

文档更新

docs/zh/context所有md和对应的link

类型标签

  • 🐛 Bug修复
  • ✨ 新特性
  • ⚡ 性能优化
  • ♻️ 重构
  • 🧪 测试
  • 📦 构建/CI
  • 🔧 配置变更
  • 📝 文档更新
  • ⬆️ 依赖升级
  • 🔒 安全修复
  • 🧹 代码清理
  • ❓ 其他,请描述:
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 chenjiao 的贡献)
Cchenjiao成员
22 天前 创建了 pull request,commit 78388859
atomgit-bot
atomgit-bot
22 天前 评论:

变更摘要

本次 PR 对 docs/zh/context 目录下"基本概念"相关的 Markdown 文件名进行了系统性修改,将原本的中文文件名(如 两段式接口.md)替换为英文文件名,并同步更新了所有文档中的内部交叉引用链接。此举旨在消除 URL 中中文字符被编码(如 %E4%B8%A4%E6%AE%B5%E5%BC%8F%E6%8E%A5%E5%8F%A3.md)后导致的链接跳转异常问题,提升文档在不同平台间的可维护性与兼容性。

主要改动

  • 中文文件名英文化:将 docs/zh/context 目录下"基本概念"类别的所有 .md 文件从中文命名改为英文命名,避免 URL 中出现 % 编码的中文字符。
  • 全量内部链接同步更新:逐一修正了所有引用被重命名文件的 Markdown 内部链接,确保重命名后文档内的交叉引用指向正确的新英文路径。
  • 消除编码跳转隐患:从根本上解决了因中文文件名在部分平台生成编码 URL 而导致的链接失效或跳转异常问题,降低了长期维护成本。
likedislike
atomgit-bot
atomgit-bot
22 天前 评论:

代码审查

经过对全部 64 个变更文件的系统性审查,包括全仓库旧中文文件名引用搜索、文件存在性验证、内部链接一致性检查,未发现需要报告的问题。

审查总结

  • 所有旧中文 .md 文件名引用已在全仓库(2488个文件)中更新完毕,无遗漏。
  • 所有重命名后的文件均存在于新路径下,旧文件已正确删除。
  • basic_concept.md(替换 基本概念.md)中的所有内部链接均正确指向对应的英文文件名。
  • 算子文档中的链接更新(两段式接口.mdtwo_phase_api.mdaclnn返回码.mdaclnn_return_code.md编译与运行样例.mdcompile_and_run_sample.mdbroadcast关系.mdbroadcast_relationship.md)均正确且相对路径有效。
  • 尾随空格清理(non_contiguous_tensor.md 及多个算子文档中的 blockquote/C++ 代码块)不改变 Markdown 渲染语义,无功能影响。

各文件审查结果汇总:

文件 结果
docs/QUICKSTART.md 无问题(移除具体 bash 命令示例,属于文档内容调整,非安全/正确性问题)
docs/README.md 无问题
docs/zh/context/aclnn_return_code.md 无问题(纯重命名)
docs/zh/context/basic_concept.md 无问题(新增,替代旧中文文件,链接正确)
docs/zh/context/broadcast_relationship.md 无问题(纯重命名)
docs/zh/context/compile_and_run_sample.md 无问题(纯重命名)
docs/zh/context/conversion_relationship.md 无问题(纯重命名)
docs/zh/context/data_format.md 无问题(纯重命名)
docs/zh/context/data_structure.md 无问题(纯重命名)
docs/zh/context/data_type.md 无问题(纯重命名)
docs/zh/context/deduction_relationship.md 无问题(链接更新正确)
docs/zh/context/non_contiguous_tensor.md 无问题(重命名+尾随空格清理)
docs/zh/context/quant_mode_introduction.md 无问题(纯重命名)
docs/zh/context/sparse_mode_introduction.md 无问题(纯重命名)
docs/zh/context/two_phase_api.md 无问题(纯重命名)
docs/zh/install/quick_install.md 无问题(文档内容调整,非安全/正确性问题)
docs/zh/menu_aclnn_api.md 无问题
其余 47 个算子文档 无问题(链接更新+尾随空格清理)

整体风险评估:低风险。 此变更为纯文档文件名英文化及关联链接更新,逻辑正确,无安全风险,无断裂链接。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
22 天前 评论:

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


PR Approval Progress

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

Module Approval Details

module lgtm status approve status
*/*/docs/acl*.md 杜慧萍, 刘伟, 顾宝成 (3/2) 杜慧萍 (1/1)
experimental 刘伟, 杜慧萍, 顾宝成 (3/2) 刘伟, 杜慧萍 (2/1)
repo-cann/ops-cv 顾宝成, 刘伟 (2/2) 刘伟 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
22 天前 将yu-xinjie62,zhou-qilong,gitee-duhuiping,wei-peng-1991,renruhai,zhajianqing123,rxtfeng,luowen203_gg123,loov1,tang-lei01,zhangzijie,zl_hw,liu-wei,fullt,LiWei79,songkai111,demoauguste,llimwang,zhouwenfang,gubaocheng,wangyongguang,wuyao51511,caiwenwen设为评审人
CANN-robotCANN-robot成员
22 天前 将yu-xinjie62,zhou-qilong,gitee-duhuiping,wei-peng-1991,renruhai,zhajianqing123,rxtfeng,luowen203_gg123,loov1,tang-lei01,zhangzijie,zl_hw,liu-wei,fullt,LiWei79,songkai111,demoauguste,llimwang,zhouwenfang,gubaocheng,wangyongguang,wuyao51511,caiwenwen设为审查人
chenjiao成员
22 天前 评论:

compile

likedislike
Cchenjiao成员
22 天前 update merge request[project id: 7657293, iid: 1151, commit_id: fed733f67070b111d159fa9940f83a24fc73b7fe] virtual merging success
Cchenjiao成员
22 天前 修改了pull request 的描述
CANN-robotCANN-robot成员
22 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
22 天前 评论:

流水线任务触发成功
任务链接 [38b38182d4344854b711ee1ba754587f][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5 ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Pre ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_classify ✅ SUCCESS >>>>>
Compile_Ascend_X86_mobile_station_9030_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>
UT_Test_harmony-infer-chs-cv ✅ SUCCESS
UT_Test_report_lcov ✅ SUCCESS

[2026-07-22 16:31:32]    CI执行结束

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

流水线任务触发成功
任务链接 [7f3ba0eae2f0463899d5e2cfb8780d6d][流水线指导]

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-22 16:24:15]    CI执行结束

likedislike
atomgit-bot
atomgit-bot22 天前进行代码检视1
docs/zh/context/non_contiguous_tensor.md
@@ -19,0 +16,4 @@
16+> a<sub>6,0</sub> , a<sub>6,1</sub> , **a<sub>6,2</sub> , a<sub>6,3</sub> , a<sub>6,4</sub> , a<sub>6,5</sub> , a<sub>6,6</sub>** , a<sub>6,7</sub> , a<sub>6,8</sub> , a<sub>6,9</sub>
17+> a<sub>7,0</sub> , a<sub>7,1</sub> , **a<sub>7,2</sub> , a<sub>7,3</sub> , a<sub>7,4</sub> , a<sub>7,5</sub> , a<sub>7,6</sub>** , a<sub>7,7</sub> , a<sub>7,8</sub> , a<sub>7,9</sub>
18+> a<sub>8,0</sub> , a<sub>8,1</sub> , a<sub>8,2</sub> , a<sub>8,3</sub> , a<sub>8,4</sub> , a<sub>8,5</sub> , a<sub>8,6</sub> , a<sub>8,7</sub> , a<sub>8,8</sub> , a<sub>8,9</sub>
19+> a<sub>9,0</sub> , a<sub>9,1</sub> , a<sub>9,2</sub> , a<sub>9,3</sub> , a<sub>9,4</sub> , a<sub>9,5</sub> , a<sub>9,6</sub> , a<sub>9,7</sub> , a<sub>9,8</sub> , a<sub>9,9</sub>
atomgit-bot
atomgit-bot22 天前评论:

🟡 Medium Priority

docs/zh/context/non_contiguous_tensor.md 中,示例1(第10-19行)和示例2(第27-36行)的引用块矩阵行原本每行末尾有两个尾随空格( ),这是 Markdown 中的强制换行语法(hard line break,产生 <br>),用于将 10 行矩阵数据各行渲染为独立行。

此 diff 将所有尾随空格移除后,在标准 Markdown 渲染器(如 GitHub Flavored Markdown)中,连续的引用块行(无空行分隔)会被合并为单个段落。这意味着原本 10 行独立显示的矩阵行将全部合并为一行长段落,矩阵结构完全不可读。

受影响的行

  • 示例1:第10行至第19行(共10行矩阵数据)
  • 示例2:第27行至第36行(共10行矩阵数据)

触发条件:任何使用标准 Markdown 渲染器(GitHub、GitCode、大多数文档平台)查看此文件时即可复现。

修复方案:恢复每行末尾的两个空格( ),或改用 HTML <br> 标签,或将每行用空行分隔(但这会改变视觉间距)。

建议:在每行末尾恢复两个尾随空格(Markdown hard line break 语法),使矩阵各行独立渲染。示例1第10-19行和示例2第27-36行均需恢复。

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
22 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
22 天前 添加了label:ci-pipeline-passed
吴瑶成员
22 天前 评论:

/lgtm
/approve

likedislike
liu-wei
liu-wei成员
22 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:approved
liu-wei
liu-wei成员22 天前进行代码检视2
image/rasterizer/docs/aclnnRasterizer.md
已过期
@@ -111,7 +111,7 @@
111111 
112112## 函数原型
113113 
114-每个算子分为[两段式接口](../../../docs/zh/context/两段式接口.md),必须先调用“aclnnRasterizerGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnRasterizer”接口执行计算。
114+每个算子分为[两段式接口](../../../docs/zh/context/two_phase_api.md),必须先调用“aclnnRasterizerGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnRasterizer”接口执行计算。
115115 
116116```Cpp
117117aclnnStatus aclnnRasterizerGetWorkspaceSize(
@@ -276,7 +276,7 @@
276276 </table>
277277- **返回值**
278278 
279279 aclnnStatus:返回状态码,具体参见[aclnn返回码](https://gitcode.com/cann/ops-cv/blob/master/docs/zh/context/aclnn%E8%BF%94%E5%9B%9E%E7%A0%81.md)。
liu-wei
liu-wei22 天前评论:

🟢 Low:这里还指向旧的 URL 编码中文文件名 docs/zh/context/aclnn返回码.md。本 PR 已将该文件重命名为 docs/zh/context/aclnn_return_code.md,合入后该链接会 404;建议改成相对路径 ../../../docs/zh/context/aclnn_return_code.md,和本文件其它 context 链接保持一致。

likedislike
System
系统消息系统
22 天前 评论:
likedislike
Cchenjiao成员
22 天前 update merge request[project id: 7657293, iid: 1151, commit_id: 1ede1c0bc1428e08c317b5176d6c6cc4e9d3fe23] virtual merging success
Cchenjiao成员
22 天前 推送  1 个提交:b20023a2-fix(docs): 修正 aclnnRasterizer 文档中 aclnn返回码 链接为相对路径
Cchenjiao成员
22 天前 update merge request[project id: 7657293, iid: 1151, commit_id: 4b18d97ddbc43bf0524eeb53905c62f081fdea3b] virtual merging success
CANN-robotCANN-robot成员
22 天前 添加了label:stat/needs-squash
CANN-robotCANN-robot成员
22 天前 删除了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
22 天前 评论:

Notification

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

likedislike
CANN-robotCANN-robot成员
22 天前 删除了label:approved
CANN-robot
CANN-robot成员
22 天前 评论:

Notice

New code changes of the pull request are detected and remove these labels approved. 😳

likedislike
chenjiao成员
22 天前 评论:

compile

likedislike
Cchenjiao成员
22 天前 update merge request[project id: 7657293, iid: 1151, commit_id: 971c7386e71ef8d3f2ffba50f30bf8325b86bc70] virtual merging success
CANN-robotCANN-robot成员
22 天前 删除了label:api-check-pass
CANN-robotCANN-robot成员
22 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
22 天前 评论:

流水线任务触发成功
任务链接 [c280c76f11d54f8b889ef322a0662821][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5 ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Pre ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_classify ✅ SUCCESS >>>>>
Compile_Ascend_X86_mobile_station_9030_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>
UT_Test_harmony-infer-chs-cv ✅ SUCCESS
UT_Test_report_lcov ✅ SUCCESS

[2026-07-22 17:11:23]    CI执行结束

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

流水线任务触发成功
任务链接 [eb6b428775014df883329d5b047f5bd1][流水线指导]

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-22 17:01:57]    CI执行结束

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
22 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
22 天前 添加了label:ci-pipeline-passed
liu-wei
liu-wei成员
22 天前 评论:

/lgtm
/approve

likedislike
Cchenjiao成员
22 天前 解决了最后一个问题
gitee-duhuiping成员
22 天前 评论:

/lgtm
/approve

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

/lgtm

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:lgtm
CANN-robotCANN-robot成员
22 天前 关闭了关联的issue
CANN-robotCANN-robot成员
22 天前 合入了pull request