Pull Request已成功合入, 合并人@CANN-robot
(感谢 JC1126 的贡献)变更摘要
本次 PR 主要对文档侧边栏的目录层次进行重构,涉及 sidebar.mjs 和 outline-index.json 两个文件。核心改动是简化「资源管理」和「同步控制」板块的侧边栏导航层级:移除了 Pipe和Que框架、临时空间管理、内存管理 等中间分组目录,将原本嵌套的 API 条目直接提升到上级菜单下,并将 TQueSync 从可折叠子分组扁平化为独立的平级链接。
主要改动
-
移除「Pipe和Que框架」中间层级:
TPipe、TBufPool、自定义TBufPool、TQue、TSCM、TQueBind、TBuf、GetTPipePtr等所有原本位于资源管理/Pipe和Que框架/下的链接路径,统一改为资源管理/直接访问,扁平化为一级子项。 -
移除「临时空间管理」中间层级:
workspace下的GetSysWorkSpacePtr、SetSysWorkSpace、GetUserWorkspace及PopStackBuffer的路径前缀从资源管理/临时空间管理/改为资源管理/。 -
移除「内存管理」中间层级:
LocalMemAllocator及其子页面(LocalMemAllocator构造函数、GetCurAddr-72、Alloc)的路径从资源管理/内存管理/LocalMemAllocator/改为资源管理/LocalMemAllocator/。 -
扁平化
TQueSync子分组:核内同步下原本的TQueSync可折叠分组(含「模板参数」和「SetFlag/WaitFlag」两个子项)被拆分为两个独立的平级链接——TQueSync模板参数和SetFlag/WaitFlag,并同步更新outline-index.json。


代码审查
审查总结
共审查 146 个变更文件,发现 6 个问题:
| 优先级 | 数量 | 说明 |
|---|---|---|
| P0 | 1 | sidebar.mjs JSON 语法错误(缺少逗号),会导致构建失败 |
| P1 | 1 | sidebar.mjs Mutex 条目引用已删除的旧路径,用户点击将 404 |
| P2 | 2 | 两处链接指向核内同步总览页而非正确的 Mutex 详情页 |
| P3 | 2 | TQueSync 链接降级 + 资源管理侧边栏结构未展平(一致性建议) |
各文件审查结果
存在问题的文件:
docs/vitepress/docs/.vitepress/sidebar.mjs— P0 缺少逗号、P1 Mutex 旧路径、P3 冗余分组docs/api/SIMD-API/基础API/同步控制/系统同步能力概述.md— P2 Lock/Unlock 链接错误docs/guide/跨代迁移兼容性指南/3510架构迁移指导/2201到3510架构变更.md— P2 Mutex 链接错误docs/api/SIMD-API/基础API/基础API列表.md— P3 TQueSync 链接降级
无问题的文件(仅路径更新或重命名,确认无缺陷):
docs/api/README.md— 目录结构展平,路径更新正确docs/api/SIMD-API/C-API/C-API.md— asc_loadalign/asc_storealign 链接更新正确docs/api/SIMD-API/C-API/reg/reg_load/asc_loadalign_v1.md~v6.md— 相对路径修正正确docs/api/SIMD-API/C-API/reg/reg_load/reg_load.md— 展平结构正确docs/api/SIMD-API/C-API/reg/reg_store/asc_storealign_v1.md~v5.md— 相对路径修正正确docs/api/SIMD-API/C-API/reg/reg_store/reg_store.md— 展平结构正确docs/api/SIMD-API/基础API/Memory矢量计算/数据搬运/下 12 个搬运接口文档 — 相对路径修正正确docs/api/SIMD-API/基础API/Memory矢量计算/数据搬运/数据搬运.md— 展平结构正确docs/api/SIMD-API/基础API/Memory矢量计算/数据搬运辅助配置接口/SetPadValue_ISASI.md— 路径修正正确docs/api/SIMD-API/基础API/Reg矢量计算/概述.md— 路径修正正确docs/api/SIMD-API/基础API/同步控制/核内同步/下 Lock.md、Mutex_ISASI.md、SetFlag-WaitFlag.md、SetFlag_WaitFlag_ISASI.md、TQueSync模板参数.md、Unlock.md、核内同步.md — 路径修正正确docs/api/SIMD-API/基础API/数据搬运导览/下 GM与UB数据搬运.md、UB与UB数据搬运.md — 路径修正正确docs/api/SIMD-API/基础API/缓存控制/系统缓存概述.md— 路径修正正确docs/api/SIMD-API/基础API/资源管理/下 GetTPipePtr.md、PopStackBuffer.md、资源管理.md 及 TBuf/、TBufPool/、TPipe/、TQue/、TQueBind/、TSCM/、workspace/、LocalMemAllocator/、自定义TBufPool/ 子目录 — 仅重命名/路径修正docs/api/SIMD-API/高阶API/下 Fill-97.md、REGIST_MATMUL_OBJ.md — 路径修正正确docs/asc_a5_feature_guide.md— 路径修正正确docs/guide/算子实践参考/下各文档 — 路径修正正确docs/guide/编程指南/下各文档 — 路径修正正确docs/vitepress/docs/.vitepress/theme/outline-index.json— 单项 key 变更,无问题examples/下 3 个 README.md — 路径修正正确
已删除文件(7 个汇总页,均为预期删除):
asc_loadalign/asc_loadalign.md、asc_storealign/asc_storealign.mdGM与UB数据搬运/GM与UB数据搬运.md、UB与UB数据搬运/UB与UB数据搬运.mdPipe和Que框架/Pipe和Que框架.md、临时空间管理/临时空间管理.md、内存管理/内存管理.mdMutex_ISASI/Mutex_ISASI.md、TQueSync/TQueSync.md
整体风险评估
中高风险:sidebar.mjs 存在一个构建阻塞的语法错误(P0)和一组会导致 404 的过期路径(P1),必须在合并前修复。其余问题为链接精度退化,影响较低(P2/P3)。文档内容的路径更新整体正确,无死链(除 sidebar 中未更新的 Mutex 条目外)。
| 类型 | 数量 |
|---|---|
| 🔴 阻塞 | 2 |
| 🟡 建议 | 4 |
⛔ 需要修改


Thanks for your pull-request.
The full list of commands accepted by me can be found at here。
You can get sig-info at here
PR Approval Progress
✅ Congratulations! All modules have met the lgtm and approve requirements.
Module Approval Details
| module | lgtm status | approve status |
|---|---|---|
| ** | ✅ munanhw, bianque (2/2) | ✅ munanhw (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
JC1126, thanks for your pull request. All authors of the commits have signed the CLA. 👍


描述
修改数据搬运和资源管理等目录层次
关联的Issue
测试
文档更新
类型标签