已关闭
[Bug-Report|缺陷反馈]: experimental/math/trace_v2/README.md 中 test_trace 链接指向不存在的路径 #2455
gcw_93rlw6ed创建于  8月1日关闭于  8月1日
gcw_93rlw6ed
8月1日 创建

一、问题描述 (必填)

文件 experimental/math/trace_v2/README.md 第 35 行存在一处失效链接,链接文本为 test_trace,target 为 ../../../math/trace/examples/test_aclnn_trace.cpp

该链接存在两个问题:

问题 1:链接 target 指向的目录不存在

math/trace/examples/ 目录不存在。math/trace/ 目录下只有 arch35/ 子目录和 test_geir_trace.cpp 文件,并没有 examples/ 子目录。

问题 2:trace_v2 算子的真实测试文件位于算子自身目录

trace_v2 算子的真实测试文件是 experimental/math/trace_v2/examples/test_aclnn_trace_v2.cpp,即位于算子自身的 examples/ 子目录下,且文件名带 _v2 后缀。README 中的链接既指向了错误的外部路径 math/trace/,又使用了错误的文件名 test_aclnn_trace.cpp(缺少 _v2 后缀)。

二、环境信息 (可选)

  • 仓库:cann/ops-math
  • 分支:master
  • 文件路径:experimental/math/trace_v2/README.md
  • 失效链接所在行:35
  • 验证方式:本地 clone master 分支后用 lsfind 验证

三、重现步骤 (可选)

  1. git clone -b master https://gitcode.com/cann/ops-math.git && cd ops-math
  2. 查看链接:sed -n '35p' experimental/math/trace_v2/README.md
    输出:| aclnn接口 | [test_trace](../../../math/trace/examples/test_aclnn_trace.cpp) | 通过[aclnnTrace]接口方式调用trace算子。 |
  3. 验证 target 目录不存在:ls math/trace/examples/ → No such file or directory
  4. 查看 math/trace 实际内容:ls math/trace/ → 只有 arch35/test_geir_trace.cpp
  5. 查找 trace_v2 真实测试文件:find experimental/math/trace_v2 -name "test_aclnn*"experimental/math/trace_v2/examples/test_aclnn_trace_v2.cpp
  6. 在 GitCode Web 界面打开 experimental/math/trace_v2/README.md,点击第 35 行 test_trace 链接,跳转 404

四、预期结果 (可选)

修复 experimental/math/trace_v2/README.md 第 35 行链接 target,指向 trace_v2 算子自身 examples 目录下的真实测试文件:

  • 修复前:[test_trace](../../../math/trace/examples/test_aclnn_trace.cpp)
  • 修复后:[test_trace](../examples/test_aclnn_trace_v2.cpp)

说明:experimental/math/trace_v2/README.mdexperimental/math/trace_v2/examples/test_aclnn_trace_v2.cpp 的相对路径是 ../examples/test_aclnn_trace_v2.cpp(README 所在目录是 trace_v2/,向上一级到 trace_v2/ 自身再进 examples/,实际就是同目录的 examples/ 子目录,可直接用 ./examples/test_aclnn_trace_v2.cppexamples/test_aclnn_trace_v2.cpp)。

经核对,正确的相对路径写法为:[test_trace](./examples/test_aclnn_trace_v2.cpp),与同仓其他算子 README 的链接风格保持一致。

五、修复建议 (可选)

该问题根因疑似 trace_v2 算子的 README 从 trace(v1)算子复制而来,未将链接 target 从 math/trace/examples/test_aclnn_trace.cpp 更新为 trace_v2 自身的 examples/test_aclnn_trace_v2.cpp。建议:

  1. 修复本链接 target,改为指向 trace_v2 自身的 ./examples/test_aclnn_trace_v2.cpp
  2. 全仓扫描 experimental/**/README.md 中所有指向 ../../../math/../../math/ 的相对链接,校验 target 文件是否真实存在。
  3. 可在 CI 文档检查流程中增加「相对链接 target 必须真实存在」的校验。

💡 备注(选填)

本 issue 与 issue #2454(right_shift 算子文档失效链接)属同类问题,建议统一在 CI 中增加相对链接存在性校验。

likedislike
songkai111成员
8月1日 评论:

确实存在问题,已安排相关责任人修复

likedislike
Ssongkai111成员
8月1日 关联了pull request:fix: 修复多个文档中的失效链接(#2455/#2456/#2457/#2458/#2459)
CANN-robotCANN-robot成员
8月1日 关闭了 issue
CANN-robotCANN-robot成员
8月1日 添加了label:resolved