master

cann-robotdocs: use defined INSTALL_DIR for msaicerr path

7a451372创建于 3 天前历史提交

文件	最后提交记录	最后更新时间
design	【docs】调整docs下的目录结构及涉及到得对应链接。 Co-authored-by: lwx1255555<liuxiaofang17@huawei-partners.com> # message auto-generated for no-merge-commit merge: !789 merge master into master 【docs】调整docs下的目录结构及涉及到得对应链接。 Created-by: lwx1255555 Commit-by: lwx1255555 Merged-by: cann-robot Description: ## 描述 背景：原docs目录下各个手册和设计文档平铺展示，可读性不友好。 实现：调整docs下的目录结构及涉及到得对应链接。调整后目录按照产品文档（user_guide）和设计文档（design）两大类呈现，产品文档中再按照手册名称区分。 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug 修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/oam-tools!789	16 天前
user_guide	docs: use defined INSTALL_DIR for msaicerr path Co-authored-by: aodebiao<18003961989@163.com> # message auto-generated for no-merge-commit merge: !853 merge docs/fix-env-setup-command-20261027 into master docs: use defined INSTALL_DIR for msaicerr path Created-by: gxhgxh2475698 Commit-by: aodebiao Merged-by: cann-robot Description: ## Motivation The Chinese and English msaicerr setup pages introduce ${INSTALL_DIR} for the CANN installation, but then direct users to ${install_path}/tools/msaicerr. install_path is never defined, so following the path literally can lead to /tools/msaicerr instead of the installed tool directory. ## Changes - Use ${INSTALL_DIR}/tools/msaicerr in both msaicerr setup pages. - Format the path as inline code so the variable name stays clear in the rendered documentation. ## Validation - Confirmed both original pages refer to ${install_path} after defining only ${INSTALL_DIR}. - Confirmed both updated Markdown pages render the same ${INSTALL_DIR}/tools/msaicerr path. - git diff --check: passed. Documentation only; no CANN/NPU runtime test was performed. Closes #379 See merge request: cann/oam-tools!853	3 天前
package_install.md	【docs】调整docs下的目录结构及涉及到得对应链接。 Co-authored-by: lwx1255555<liuxiaofang17@huawei-partners.com> # message auto-generated for no-merge-commit merge: !789 merge master into master 【docs】调整docs下的目录结构及涉及到得对应链接。 Created-by: lwx1255555 Commit-by: lwx1255555 Merged-by: cann-robot Description: ## 描述 背景：原docs目录下各个手册和设计文档平铺展示，可读性不友好。 实现：调整docs下的目录结构及涉及到得对应链接。调整后目录按照产品文档（user_guide）和设计文档（design）两大类呈现，产品文档中再按照手册名称区分。 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 Bug 修复 - [ ] ✨ 新特性 - [ ] ⚡ 性能优化 - [ ] ♻️ 重构 - [ ] 🧪 测试 - [ ] 📦 构建/CI - [ ] 🔧 配置变更 - [x] 📝 文档更新 - [ ] ⬆️ 依赖升级 - [ ] 🔒 安全修复 - [ ] 🧹 代码清理 - [ ] ❓ 其他，请描述： See merge request: cann/oam-tools!789	16 天前
quick_install.md	fix: [Requirement|需求建议]: md文件 三方件链接老旧 (#332) Co-authored-by: sinat_31531339<yuanyue23@huawei.com> # message auto-generated for no-merge-commit merge: !825 merge fix/issue-332 into master fix: [Requirement|需求建议]: md文件 三方件链接老旧 (#332) Created-by: sinat_31531339 Commit-by: sinat_31531339 Merged-by: cann-robot Description: ## 描述 # Issue #332 修复报告：md 文件三方件链接老旧、与本地构建引用不一致 ## 修复范围说明 按 bot 核验结论（component developer's standard judgment）执行：**先核对并统一业务仓 md 文件中的三方件 URL 与本地构建实际引用**（本报告核心内容）。其余各项 （fetch_cann_cmake.cmake 升级 master-059+、下载脚本 py 改 sh、CANN_3RD_LIB_PATH/patch 目录布局、sha256 校验与二次调用缓存）为构建组件改进需求，保持现状、未在本轮实施， 相关调研信息附于文末供组件团队排期评估时参考。 ## 根因分析（已核实） 自提交 be1e6fd（refactor(cmake): 三方件改用 add_cann_third_party 统一管理）起，三方件 改由 **cann-cmake（当前 master-058）** 的 third_party/*.cmake 统一拉取，本仓 cmake/third_party/ 下的本地实现（boost.cmake / gtest_shared.cmake / mockcpp.cmake / nlohmann_json.cmake 等）已删除、后续 cann-cmake 又多次升级（049→058），但 md 文档与 离线下载脚本的 URL 未同步更新，造成三方处不一致： | 文档/脚本中的条目 | 本地构建实际引用（cann-cmake master-058） | 核验方式 | |---|---|---| | cann-cmake master-053 tar 包 | master-058（cmake/fetch_cann_cmake.cmake 的 CANN_CMAKE_TAG，URL_HASH=03d63afb…） | 下载 OBS cmake-master-058.tar.gz 实测 sha256 一致 | | makeself makeself-release-2.5.0-patch1.tar.gz（gitcode） | OBS makeself-release-2.5.0.tar.gz + OBS makeself-2.5.0.patch 两件（cann-cmake makeself-fetch.cmake 按 sha256 校验） | 两件均下载实测 sha256 一致（705d0376… / abb9efe2…）；旧 patch1 合包构建根本不查找，离线预置无效 | | mockcpp 补丁 v2.7-h2/mockcpp-2.7_py3.patch | v2.7-h5/mockcpp-2.7-h5.patch（sha256=65a2aac5…） | 下载实测一致；py3.patch 构建不使用 | | （文档缺失）abseil CVE 补丁 | 20230802.1-h0/backport-CVE-2025-0838.patch（sha256=a4e4ef6f…，protobuf 构建依赖 abseil） | 下载实测一致 | | SECURITY.md 引用 cmake/third_party/makeself-fetch.cmake、boost.cmake、eigen.cmake、gtest_shared.cmake、mockcpp.cmake、nlohmann_json.cmake | 这些文件在本仓已不存在；实际入口为 CMakeLists.txt 的 add_cann_third_party(...) 与 cann-cmake 自带 makeself-fetch | git ls-tree be1e6fd~1 cmake/third_party/ 确认历史存在、现仅剩 third_party_header_libs.cmake | | SECURITY.md 的 eigen / nlohmann_json 行 | 构建完全不下载、不引用（全仓 grep 无 eigen/nlohmann 引用，src/third_party 仅 adcore） | grep 核实 | 同时核实：文档保留的 gitcode 镜像 protobuf-25.1.tar.gz、abseil-cpp-20230802.1.tar.gz、 boost_1_87_0.tar.gz、googletest-1.14.0.tar.gz、mockcpp-2.7.tar.gz 与 cann-cmake 按 sha256 校验的 OBS 包**字节一致**（逐一下载比对），故保留 gitcode 地址不变。 ## 变更内容 ### 1. docs/zh/quick_install.md、docs/en/quick_install.md（依赖包清单） - cann-cmake 行：master-053 → master-058，URL 同步为 https://cann-3rd.obs.cn-north-4.myhuaweicloud.com/cmake/cmake-master-058.tar.gz。 - makeself 行：gitcode patch1 合包 → OBS makeself-release-2.5.0.tar.gz，并新增 makeself-patch 行（OBS makeself-2.5.0.patch）。 - mockcpp-patch 行：v2.7-h2/mockcpp-2.7_py3.patch → v2.7-h5/mockcpp-2.7-h5.patch。 - 新增 abseil-cpp-patch 行（20230802.1-h0/backport-CVE-2025-0838.patch）。 - 新增说明：两个补丁文件（makeself-2.5.0.patch、backport-CVE-2025-0838.patch）手工下载时 需存放于依赖目录 pkg/ 子目录（cann-cmake master-058 的本地缓存查找路径），其余文件在 根目录；脚本下载时自动按此布局保存。 - protobuf / abseil-cpp / boost / gtest / mockcpp 源码包行：内容与构建校验一致，保留。 ### 2. SECURITY.md、SECURITY_en.md（公网地址声明） - "文件名"列 6 处指向已不存在文件的引用改为真实入口：makeself → cann-cmake (makeself-fetch)；boost / googletest / mockcpp → cann-cmake (add_cann_third_party)。 - makeself 行拆为源码包 + 补丁两行（OBS 地址），描述同步改为"从OBS下载"。 - mockcpp 补丁 URL 更新为 v2.7-h5；新增 abseil CVE 安全补丁行（该补丁即 CVE-2025-0838 修复回合，属安全声明应披露项）。 - 删除 eigen、nlohmann_json 两行（构建不下载、仓内无引用，属重构遗留的失效披露）。 ### 3. cmake/download_libs.py（离线预置脚本，文档指向的下载入口） 使其产出与 md 清单、构建引用三方一致（脚本语言仍为 py、不加 sha256 缓存——按核验结论 这两项属排期评估的改进需求）： - 替换失效地址：makeself patch1 合包 → OBS tar + patch；mockcpp py3.patch → h5.patch。 - 补齐清单缺口：abseil CVE 补丁（pkg/ 子目录）、boost 源码包、cann-cmake cmake-master-058.tar.gz（此前清单里有、脚本不下载，离线 UT 构建缺 boost、离线全量 构建缺 cann-cmake）。 - download_single_file 支持 custom_name 携带相对子目录并预建父目录（wget -O 不自建目录）， 使 makeself/abseil 补丁落到 pkg/，与 cann-cmake master-058 本地缓存查找路径对齐； mockcpp 补丁与各 tar 包仍落根目录。 - 新增清单维护注释：URL/版本/补丁路径须与 cann-cmake 各 tag 的 third_party/*.cmake 同步， 升级 CANN_CMAKE_TAG 时同步核对（本轮链接老旧正是因为缺少该同步约束）。 ## 验证 - python3 -m py_compile cmake/download_libs.py：通过。 - python3 -m ruff check cmake/download_libs.py（仓 pre-commit 所用 Python 检查器）：All checks passed。 - 功能实测（真实下载，非 mock）： - pkg/ 子目录落盘 + sha256 比对（makeself-2.5.0.patch = abb9efe2…）✓ - 根目录落盘 + sha256 比对（mockcpp-2.7-h5.patch = 65a2aac5…）✓ - tuple 长度校验、仅允许 https 的原有防护未回归 ✓ - AST 提取脚本 my_urls 全量比对预期清单：10 条静态 URL（含 2 条 pkg/ 定制名）全部一致； bundle（动态拼接）与 msprof/msprobe 子仓条目未改动。 - 全部 12 个文档 URL 逐一 curl 实测可达且 sha256 与构建侧强校验值一致。 - 全仓 grep：master-053、patch1.tar.gz、py3.patch、eigen.cmake、nlohmann_json.cmake 零残留；md 中三方件 URL 集合与构建引用完全一致。 - codespell 报告的 CANN==>CAN 均为产品专名误报，已在仓 .typos.toml 白名单（pre-commit codespell -L 同口径），非本次引入。 - 组件 UT：python3 -m pytest test/ut/build/ -q → **本地未覆盖**（test/ut/ 下仅有 asys/msaicerr/msprof，无 build 组件用例，pytest 报 no tests ran）。 ## 供组件团队排期评估的调研信息（本轮未实施） - cann-cmake master-059 已发布：OBS tar 包 https://cann-3rd.obs.cn-north-4.myhuaweicloud.com/cmake/cmake-master-059.tar.gz， sha256=9e59939b5c97c9498293969df22ab2dd40e450700c51f84f117d065880f40d25。 - master-059 相对 058 的三方件变化（diff 实测）：补丁目录 pkg/ → patch/（makeself、 mockcpp、abseil-cpp 均改）；makeself 补丁地址改为 https://cann-3rd.obs.cn-north-4.myhuaweicloud.com/makeself/fix/makeself-2.5.0.patch （新 sha256=0ecac3fe…）。即 issue 第 3.1 条"patch 存放于 CANN_3RD_LIB_PATH/patch"正是 master-059 的行为——升级 tag、脚本补丁目录布局、py 改 sh、sha256 缓存四项宜按 cann/runtime PR 5411 的方式一体评估落地，届时需同步更新本轮改动的四处 URL/布局描述。 ## 变更类型 请选择本次引入的变更类型（勾选对应项）： - [x] 🐛 Bug 修复 ## 关联的Issue 关联 Issue #332 ## 如何测试 - python3 -m pytest test/ut/asys/ test/ut/msaicerr/ -q — 通过 ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：feat:, fix:） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md） <!--bot:pr:v1--> See merge request: cann/oam-tools!825	9 天前