hixl/docs/en · CANN/hixl

cann-robot[refactor]: upgrade cann-cmake to master-044, replace local pack/sign with cann-cmake APIs

文件	最后提交记录	最后更新时间
contributions	[docs]: 新增C++通用编码规范三条规则 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !781 merge docs/add-cpp-general-rules into master [docs]: 新增C++通用编码规范三条规则 Created-by: lining23666 Commit-by: lining23666 Merged-by: cann-robot Description: 提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> 在 `docs/zh` 和 `docs/en` 的 `contributions/coding_standards/cpp-general.md` 中同步新增三条 C++ 通用编码规范，供 hixl-pr-review 检视时参照执行： 1. 规则 13.4 不会修改成员变量的成员函数必须使用 const 修饰（类和对象）：const 成员函数向调用者承诺不修改对象状态，是 const-correctness 的基础。样例展示 getter 返回 `const std::string &` 并加 const 修饰的正反例。 2. 建议 13.5 禁止从析构函数中抛出异常（类和对象）：C++11 起析构函数默认 noexcept，抛异常会触发 std::terminate 导致程序崩溃。样例展示在析构函数内部捕获并记录日志的正确做法。 3. 建议 15.8 函数的所有声明必须与定义具有一致的参数名（函数使用）：C++ 标准不要求一致，但不一致会降低可读性。适用于所有 C++ 函数，声明中省略参数名不视为不一致。三条规则均标记为 SUSPICIOUS 级别，样例统一采用下划线命名风格。hixl-pr-review 下次检视时会自动将这三条纳入「C++ 通用编码规范检查」表格输出，无需改 skill 代码。 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> - 对中英文文档改动运行 `pre-commit run --files`，全部 hook（trailing-whitespace、end-of-file-fixer、codespell、OAT 合规检查等）通过。 - 人工核对中英文内容一致、表格编号连续、Markdown 语法正确。 ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> - pre-commit 全部 Passed，OAT 合规检查 [OK] All checks passed (2 file(s) checked)。 - 中英文文档规则条目、编号、正反例代码块一一对应。 ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> 本次新增的三条规则在讨论中确定：13.4/13.5 归入第13章「类和对象」（与 13.3 virtual/override/final 同属成员函数限定符主题），15.8 归入第15章「函数使用」（与 15.1/15.2 参数一致性主题相邻）。规则强度均定为 SUSPICIOUS，与近期新增规则保持一致，渐进推行。 See merge request: cann/hixl!781	3 天前
design	【docs】增翻md文档 Co-authored-by: lwx1255555<liuxiaofang17@huawei-partners.com> # message auto-generated for no-merge-commit merge: !696 merge master into master 【docs】增翻md文档 Created-by: lwx1255555 Commit-by: lwx1255555 Merged-by: cann-robot Description: 提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> 【docs】增翻md文档 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> 已自检 ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> 已自检 ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> See merge request: cann/hixl!696	25 天前
figures	hixl仓docs和example翻译合入 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !675 merge master into master hixl仓docs和example翻译合入 Created-by: yuwang- Commit-by: yuwang-;lining23666 Merged-by: cann-robot Description: 提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> hccl部分英文文档合入 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> See merge request: cann/hixl!675	28 天前
FabricMem.md	[docs]:文档整改 Co-authored-by: tangjie66<tangjie66@huawei.com> # message auto-generated for no-merge-commit merge: !734 merge dochixl into master [docs] 文档整改 Created-by: tangjie66 Commit-by: tangjie66 Merged-by: cann-robot Description: 提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> 文档内容优化 https://gitcode.com/cann/hixl/issues/420 https://gitcode.com/cann/hixl/issues/419 https://gitcode.com/cann/hixl/issues/418 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> See merge request: cann/hixl!734	17 天前
build.md	[refactor]: upgrade cann-cmake to master-044, replace local pack/sign with cann-cmake APIs Co-authored-by: zhaoyingdong<zhaoyingdong@huawei.com> # message auto-generated for no-merge-commit merge: !791 merge master into master [refactor]: upgrade cann-cmake to master-044, replace local pack/sign with cann-cmake APIs Created-by: zhaoyingdong Commit-by: zhaoyingdong Merged-by: cann-robot Description: 提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [x] 代码重构 - [ ] 文档更新 - [ ] 其他，请描述： ## 描述升级 cann-cmake 依赖版本 master-034 → master-044，并将本地自制的 pack/sign 函数替换为 cann-cmake 公共 API，消除与 cann-cmake 重复的>本地脚本和辅助文件，降低维护成本。通过基线对照构建验证 device 侧 tar 包内容与升级前完全一致。主要改动： - cmake/fetch_cann_cmake.cmake：CANN_CMAKE_TAG 由 master-034 升级为 master-044，同步更新 URL_HASH。 - cmake/device/CMakeLists.txt： - pack_targets_and_files 替换为 cann_pack_targets_and_files，删除冗余 FILES ""，改用 TAR_ROOT_DIR aicpu_kernels_device 生成包内根>目录。 - sign_file 替换为 add_cann_sign_file，新增 VERSION "${CANN_VERSION_hixl_VERSION}" 从 device 侧直接取版本号，不再依赖 host 侧 VERSION_INFO 传递。 - build.sh：CUSTOM_SIGN_SCRIPT 默认值改为空，使 cann-cmake 使用自带签名脚本；CMake 参数改为 ${CUSTOM_SIGN_SCRIPT:+-D ...} 条件传递，避免传空值。 - cmake/function.cmake：删除本地 pack_targets_and_files、sign_file 函数定义及仅被其使用的 _FUNC_CMAKE_DIR、_ROOT_DIR 变量。 - 删除与 cann-cmake 自带文件重复的本地脚本： - cmake/_pack_stage.cmake - scripts/sign/add_header_sign.py、scripts/sign/common_log.py、scripts/sign/community_sign_build.py - scripts/signtool/（整个目录） - 保留 scripts/sign/hixl_check_cfg.xml（项目专属签名配置）。 - 更新 docs/zh/build.md、docs/en/build.md 第三方依赖表 cann-cmake 版本号与下载链接。 ## 测试项基线对照构建（CANN 9.1.0，ENABLE_SIGN=OFF，Release）： - 父提交 b235aaa（master-034）干净构建，保留 device 侧产物。 - 目标提交 dab8c0f（master-044）干净构建，保留 device 侧产物。 device 侧 tar 包逐项比对： - 解压 cann-hixl-compat.tar.gz 后文件树、kernel so 内容 sha256、权限。 - device-hixl.tar.gz 内 kernel json 内容 sha256、install 路径。 - pack 产物、签名产物、最终 .run 包整体 sha256。验证 add_cann_sign_file 在 ENABLE_SIGN=OFF 时的签名产物路径与 install 来源。 ## 测试结果基线构建（b235aaa）：通过，cann-hixl_9.1.0_linux-aarch64.run 正常生成。修改构建（dab8c0f）：通过，cann-hixl_9.1.0_linux-aarch64.run 正常生成。 device 侧 tar 包内容比对（核心结论）： - libcann_hixl_kernel.so 内容 sha256：基线 db27438a1f4af9f74e50a68ab7673fc5cd875c50f135929c89db700db40ede69，修改后一致。 - libcann_hixl_kernel.json 内容 sha256：基线 9b08dff4317b8191810854c3372d4c601a5f504db450d8b563ad3846aa5fe9a8，修改后一致。 - 解压后文件树：均为 aicpu_kernels_device/libcann_hixl_kernel.so，一致。 - 文件权限：均为 0o750，一致。 - device-hixl.tar.gz 内 kernel 目录结构、json/tar 路径：一致。 install 来源一致：修改版签名产物在 signatures_cann_hixl_compat_tar_gz/ 目录（命名由 add_cann_sign_file 实现按输入名隔离），与 pack >产物 sha256 相同，install 通过 RESULT_VAR 变量取值，逻辑等价。无害差异（不影响功能，仅打包元数据层面）： - pack 产物 tar 条目路径：旧 aicpu_kernels_device/./libcann_hixl_kernel.so（tar --transform 对 . 加前缀），新 aicpu_kernels_device/libcann_hixl_kernel.so（物理子目录打包），解压后等价。 - signatures 目录名：旧 signatures/，新 signatures_cann_hixl_compat_tar_gz/（支持多输入隔离）。 - pack 产物与最终 .run 包整体 sha256 字节级不同：由 gzip 时间戳和 tar 条目路径格式导致，非内容差异。 ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> See merge request: cann/hixl!791	1 天前