Open
[Documentation|文档反馈]: OpsRas 安装文档缺少 `--full` #49
KaranocaVeAdd on  Sep 25
KaranocaVe
KaranocaVe
Sep 25 Create

[Documentation|文档反馈]: OpsRas 安装文档缺少 --full

Document Link(文档链接)

docs/QUICKSTART.md at the affected revision

同类示例还出现在 docs/QUICKSTART_en.md 以及 docs/{en,zh}/{debug,develop,install,invocation} 下的相关文档中;共涉及 12 个文件、18 条命令。

Issues Section(问题文档片段)

./build_out/cann-ops-ras-*linux*.run

Existing Issues(存在的问题)

在 cann/ops-ras@e43ac41176f9c57fd0d38db8f53354016b90f8b2 中,安装器要求恰好指定一个操作类型。文档中的上述命令未指定操作类型,运行时会在安装前以状态码 1 退出;添加 --full 后会进入完整安装模式。

这导致用户照着 Quick Start 及相关安装文档执行时无法安装 OpsRas。修复只为缺少操作类型的 .run 示例补上 --full,保留已有完整命令。固定源码上的参数解析对照确认缺少操作类型时失败、添加 --full 后成功;补丁应用检查和安装脚本语法检查均通过。未执行真实 .run 安装。

关联 PR: https://gitcode.com/cann/ops-ras/merge_requests/123

likedislike
KaranocaVeKaranocaVe
Sep 26 Associated pull request
KaranocaVeKaranocaVe
Sep 26 Modify description of issue
yue-maCollaborators
Sep 27 Comments:

@KaranocaVe 你好,建议按照issue模板来创建issue呢

likedislike
yue-maCollaborators
Sep 27 Comments:

/assign @KaranocaVe

likedislike
CANN-robotCANN-robotCollaborators
Sep 27 Assign KaranocaVe as responsible person
KaranocaVeKaranocaVe
Oct 3 Change title to "[Documentation|文档反馈]: OpsRas 安装文档缺少 `--full`", originally titled "OpsRas 安装文档缺少 `--full`".
KaranocaVeKaranocaVe
Oct 3 Modify description of issue
KaranocaVeKaranocaVe
Oct 3 Added label: documentation
KaranocaVe
KaranocaVe
Oct 3 Comments:

已按文档反馈模板整理了正文,补上文档链接和问题片段,并说明实际表现、修复内容和验证范围。

likedislike
zWaNg3
17 days ago Comments:

您好,感谢按模板补充信息。

问题分析

已在当前 master(commit 6918d51)复核安装脚本和文档:

  • scripts/package/ops_ras/scripts/install.sh:336-396 只把 --full、--upgrade、--uninstall、--check 计入操作类型数量,--install-path、--quiet、--install-for-all 都是附加参数;check_opts 要求操作类型数量恰好为 1,否则在安装前报参数错误并退出。因此只执行 .run 或 .run --install-path=... 无法安装,需要补 --full。
  • 按同一口径扫描 docs/ 下的 Markdown,当前共有 12 个文件、18 条 .run 安装命令未指定操作类型,与您的清单一致,包括 docs/QUICKSTART.md:75,154、docs/QUICKSTART_en.md:75,154、docs/{en,zh}/install/compile.md:74,277,284、docs/{en,zh}/debug/cann_sim.md:43、docs/{en,zh}/develop/aicore_develop_guide.md、docs/{en,zh}/develop/aicpu_develop_guide.md 和 docs/{en,zh}/invocation/quick_op_invocation.md。
  • 另外确认 docs/ 之外的 Markdown 没有其他 .run 安装命令,当前修复范围可以只覆盖这些文档。

处理方向

关联 PR #123 已为上述命令补充 --full,目前为 open、尚未合入,因此当前 master 仍可复现。合入后我们会按安装脚本的参数约束再核对一遍,确保 --install-path 等组合命令也带上操作类型。

likedislike
KaranocaVe
KaranocaVe
17 days ago Comments:

感谢指出。根据相关构建命令,受影响示例生成的是自定义算子包(--ops / --vendor_name),我之前把内置 OpsRas 包的 --full 要求套用到了这里。现有证据不支持这些示例缺少 --full 会导致失败,因此该问题应按误报处理。PR !123 不应继续合入,麻烦维护者关闭 Issue #49 和 PR !123。

likedislike
zWaNg3
9 days ago Comments:

感谢补充和自查,结论同意:这是误报,PR #123 不需要合入。

已在当前 master(commit 6918d51)复核:

  • 文档中的这些命令都用于安装自定义算子包:构建命令带 --ops=...,产物是 cann-ops-ras-${vendor_name}_linux-${arch}.run(docs/QUICKSTART.md:55,67),安装目标是 ${ASCEND_HOME_PATH}/opp/vendors(:78);docs/{en,zh}/install/compile.md 也明确写的是 custom operator package / 自定义 run 包。
  • 自定义包对应的 scripts/custom/install.sh 参数循环(:31-50)只识别 --quiet 和 --install-path=,其余 --* 参数直接 shift 忽略,既不统计也不要求 full/upgrade/uninstall/check 操作类型,因此不带 --full 不会在预检阶段失败;带 --full 也只是被忽略,不会“进入完整安装模式”。
  • check_opts()(scripts/package/ops_ras/scripts/install.sh:387-398)的“恰好一个操作类型”约束属于内置 OpsRas 包安装器,只适用于 cann-${soc_name}-ops-ras_${cann_version}_...run,不适用于这些自定义包命令。我上一轮把两者混用了,感谢你指出。

因此确认按误报处理,Issue #49 与 PR #123 无需继续推进。

likedislike