已关闭
[Documentation|文档反馈]: 英文 README 5 处入口误链中文文档;英文快速入门漏 pkg-config 依赖;README/CHANGELOG“仿存合并”错别字 #1667
Jon-Snow创建于  18 天前关闭于  16 天前
Jon-Snow
18 天前 创建

场景

英文使用者按 README_en 快速入门、选择 API、查 CHANGELOG;英文开发者按 docs/en/quick_start.md 准备编译环境。

问题

  1. 英文 README 误链中文文档(对应英文文件均实际存在):
    • 第 102 行 API 选择指南 → ./docs/zh/asc_how_to_choose_api.md(en 版存在);
    • 第 139 行 Compilation and Building → docs/zh/quick_start.md(en 版存在且为完整译文);
    • 第 140 行 Sample Execution → examples/README.md(examples/README_en.md 存在);
    • 第 14 行 CONTRIBUTING 徽标 → CONTRIBUTING.md(CONTRIBUTING_en.md 存在,且第 248 行自己又正确链了 en 版,自相矛盾);
    • 第 46 行 → CHANGELOG.md(CHANGELOG_en.md 存在)。
  2. 英文依赖清单漏项:docs/en/quick_start.md 第 205-209 行依赖只有 python/gcc/cmake,中文版第 208-211 行多出 - pkg-config >= 0.29.0;仓内 .devcontainer/Dockerfile 第 57 行实际安装了 pkg-config。英文用户照单准备环境会漏依赖。
  3. 错别字:README.md 第 33 行、CHANGELOG.md 第 22 行“基于 transpose 的仿存合并和 bank 冲突样例”,应为“访存合并”(英文 README_en 第 35 行对应 “transpose-based memory coalescing”,docs/zh/guide/index.md 第 321 行也作“访存合并”)。

影响范围

英文用户最核心的入门/贡献/样例入口全部落到中文页面;漏装依赖导致编译走弯路;门面文档错别字影响专业度。

复现方式

  1. Contents API 访问 5 个 en 目标文件均 200;点击 README_en 上述链接均打开 zh 页面;
  2. 对照中英 quick_start.md 依赖清单及 .devcontainer/Dockerfile 第 57 行;
  3. 搜索“仿存合并”可见 2 处。

修复建议

  1. 五处分别改为 docs/en/asc_how_to_choose_api.md、docs/en/quick_start.md、examples/README_en.md、CONTRIBUTING_en.md、CHANGELOG_en.md;
  2. 英文清单补 pkg-config 及 requirements.txt 参考;
  3. 两处“仿存”改“访存”。
likedislike
LLycheeeee成员
18 天前 将 lihuaichao 设为负责人
lihuaichao成员
18 天前 评论:

您好,感谢反馈。经核对,所列英文入口链接、英文依赖清单缺项及“仿存合并”错别字问题均属实,对应英文文档也已存在。后续将修正相关链接、补齐 pkg-config 依赖及 requirements.txt 参考链接,并将“仿存合并”统一改为“访存合并”。

likedislike
Llihuaichao成员
18 天前 关联了pull request:docs: 修复英文入口链接及依赖说明(master, #1667)
Llihuaichao成员
18 天前 关联了pull request:docs: 修复英文入口链接及依赖说明(9.2.0, #1667)
lihuaichao成员
17 天前 评论:

您好,相关修改已合入,请查看关联PR或最新主线文档。

likedislike
lihuaichao成员
16 天前 评论:

您好,相关问题已修复。

我们先关闭此issue。后续如果有其他问题,欢迎再提issue交流~

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