已关闭
[Documentation|文档反馈]: 中文 build.md npu-smi 命令被星号污染(非法参数);英文 README 6 处入口误链中文文档 #565
Jon-Snow创建于  20 天前关闭于  15 天前
Jon-Snow
20 天前 创建

场景

开发者按 docs/zh/build.md 关闭 dflow 验签;英文使用者通过 README_en 访问样例、贡献指南与联系方式。

问题

  1. 命令被 Markdown 标记污染(L3):docs/zh/build.md 第 208-209 行(6 空格代码块内):
    npu-smi set -t custom-op-secverify-enable -i ***0*** -d 1
    npu-smi set -t custom-op-secverify-mode -i ***0*** -d 0
    ***0*** 会被原样复制,-i ***0*** 是非法参数;英文版 docs/en/build.md 第 210-211 行同一命令为干净的 -i 0。该操作本身有 CAUTION(root/物理机/HDK 版本前提),仅排版错误。
  2. 英文 README 误链中文文档(英文文件均实际存在):
    • 第 24-25 行两个样例链接指向 acl 样例的中文 README(样例目录下 README_en.md 存在);
    • 第 34 行 Contributing Guide → CONTRIBUTING.md(CONTRIBUTING_en.md 存在);
    • 第 51 行 Security Statement → SECURITY.md(SECURITY_en.md 存在);
    • 第 56 行联系图片 → ./docs/zh/figures/GE_contact.png(docs/en/figures/GE_contact.png 存在)。

影响范围

关闭验签命令照抄必报参数错误,关键操作受阻;英文用户入口全部落到中文页面。

复现方式

  1. 打开 docs/zh/build.md 第 208-209 行可见星号,对照 docs/en/build.md 第 210-211 行;
  2. Contents API 验证 CONTRIBUTING_en.md、SECURITY_en.md、样例 README_en.md、docs/en/figures/GE_contact.png 均 200。

修复建议

  1. 两处删除星号写为 -i 0(或用占位符 <device_id>);
  2. 六处改指对应英文文件。
likedislike
Sspring_yb成员
20 天前 将 kantao1 设为负责人
kantao1成员
20 天前 评论:

感谢反馈。接下来会对文档进行优化整改

likedislike
Sophia1213Sophia1213成员
17 天前 关联了pull request:【PR】: 更新产品名称
CANN-robotCANN-robot成员
15 天前 关闭了 issue
CANN-robotCANN-robot成员
15 天前 添加了label:resolved