Pull Request已成功合入, 合并人@ascend-robot
(感谢 孟广欣 的贡献)代码审查
审查完成。现在提交关闭总结。
关闭总结
按优先级统计
| 优先级 | 数量 |
|---|---|
| P0 | 0 |
| P1 | 2 |
| P2 | 0 |
| P3 | 0 |
各文件审查结论
- README.md:无问题。变更是将两条安装指引合并为一条指向安装指南的链接,属于合理的文档精简。
- docs/zh/development_guide/development_guide.md:无问题。变更包括将 "MindStudio Profiler" 统一更名为 "msProf"、将开发环境配置节精简为指向安装指南的引用、以及扩充编译参数表(新增
--build_type、--version参数说明)。内容一致,无事实性错误。 - docs/zh/install_guide/msprof_install_guide.md:发现 2 个 P1 问题,均为路径不一致——第 2.3.1 节克隆仓库到
~/msprof,但第 2.3.2 节和第 2.3.3 节的编译/测试命令却使用了cd ~/msdebug。build.py位于仓库根目录,在错误路径下执行会导致命令失败,阻塞用户安装流程。第 2.3.4 节正确引用了~/msprof/artifacts,确认~/msprof为正确路径。
整体风险评估
本次变更的风险集中在安装指南的路径错误上——用户严格按照文档操作将无法完成源码编译。由于这是纯文档变更,不涉及运行时代码逻辑,修复成本低(两处路径替换),建议在合入前修正 ~/msdebug → ~/msprof。
| 类型 | 数量 |
|---|---|
| 🔴 阻塞 | 2 |
| 🟡 建议 | 0 |
⛔ 需要修改


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 |
|---|---|---|
| repo-Ascend/msprof | ✅ 陈豪, 谢作孟 (2/2) | ✅ 陈豪 (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
mengguangxin, thanks for your pull request. All authors of the commits have signed the CLA. 👍


ascend docs pipeline is running...


严重程度: 严重
问题: 源码编译步骤的工作目录写成 ~/msdebug,但上一步克隆命令 git clone https://gitcode.com/Ascend/msprof.git 实际创建的目录是 ~/msprof,两者不一致。
原因: 该目录并不存在,执行 cd ~/msdebug 会直接报 “No such file or directory” 失败,构建无法继续。本 PR 的明确目标就是“为了让 AI 也能稳定执行”而增加约束性语言,但这条指令本身正是会阻断 AI 稳定执行的错误路径。同一节内还存在多处目录名不一致:2.3.1 克隆得到 ~/msprof、2.3.2 与 2.3.3 又要求 cd ~/msdebug、2.3.4 安装时又回到 cd ~/msprof/artifacts,三处目录名互相矛盾。
怎么改:
全文统一为 ~/msprof。2.3.2(第 50 行)与 2.3.3 单元测试(第 61 行)的 cd ~/msdebug 都应改为 cd ~/msprof,与克隆结果及 2.3.4 的 ~/msprof/artifacts 保持一致:
cd ~/msprof
python3 build.py


已修改
严重程度: 建议
问题: 开发指南 4.3 节的参数表与示例仍以 bash build/build.sh 为入口、以 output/ 为产物目录,但本 PR 已将安装指南(开发指南第 3 节链接过去的环境准备来源)改为统一使用 python3 build.py、产物在 artifacts/,两份文档对同一编译步骤的描述出现分叉。
原因: 关键在于 build.py 并不接受 --mode/--build_type 参数(见 build.py 的 argparse 定义,仅支持 command/--version/--extra,且 --extra 仅打日志、未透传给 build.sh)。因此按安装指南执行 python3 build.py 时,build.sh 始终以默认 BUILD_MODE=analysis 运行,只能产出解析包,无法编译本节示例所强调的 --mode=all 全量包。读者/AI 跨文档跟随时会困惑,甚至误以为 python3 build.py --mode=all 可用(实际会报 unrecognized arguments)。
怎么改:
在 4.3 节说明推荐入口为 python3 build.py(与安装指南对齐),并明确:--mode/--build_type 是底层 build/build.sh 的参数;若需编译全量(all)或 collector 包,应直接调用 bash build/build.sh --mode=all,或评估在 build.py 中透传 --mode。同时将“产物在 output 目录”同步更新为 artifacts/,避免与安装指南再次分叉。


严重程度: 提示
问题: “介绍工具的环境依赖与安装方法,请参见《msProf 安装指南》” 前半句“介绍……”是描述性从句,与后半句祈使“请参见”拼在一起,读起来像目录说明而非给用户的指引,句式偏别扭。
原因: 同文件第 55 行“工具的详细使用方法,请参见《msProf 使用指南》”用的是更通顺的“<名词短语>,请参见……”句式,本句与之一致更好。
怎么改:
去掉“介绍”或改为与下文一致的句式,例如:
工具的环境依赖与安装方法,请参见《[msProf 安装指南](docs/zh/install_guide/msprof_install_guide.md)》。


已修改
🟠 High Priority
与第 2.3.2 节相同的问题:第 2.3.3 节"执行单元测试"(第 61 行)使用了 cd ~/msdebug,但仓库实际克隆路径为 ~/msprof(见第 2.3.1 节第 42 行)。build.py 在仓库根目录,在 ~/msdebug 下执行 python3 build.py test 会因找不到 build.py 而失败。第 2.3.4 节正确引用了 ~/msprof/artifacts,进一步确认正确路径为 ~/msprof。
建议:同上,将 cd ~/msdebug 改为 cd ~/msprof。


🟠 High Priority
安装指南第 2.3.1 节(第 42 行)将仓库克隆到 ~/msprof(git clone https://gitcode.com/Ascend/msprof.git 默认创建 msprof 目录),但第 2.3.2 节(第 50 行)和第 2.3.3 节(第 61 行)的编译和单元测试命令却使用了 cd ~/msdebug。build.py 位于仓库根目录,其内部通过 Path(__file__).resolve().parent 确定项目根目录(第 49 行),因此必须在仓库目录内执行。第 2.3.4 节(第 74 行)正确引用了 cd ~/msprof/artifacts,进一步确认仓库路径为 ~/msprof。
触发条件:用户严格按照安装指南操作时,在 ~/msdebug 目录下执行 python3 build.py 会因找不到 build.py 而失败。
影响:无法完成源码编译和单元测试,阻塞用户安装流程。
修复方向:将第 2.3.2 节(第 50 行)和第 2.3.3 节(第 61 行)的 cd ~/msdebug 统一修正为 cd ~/msprof。
建议:将 cd ~/msdebug 改为 cd ~/msprof,使编译命令与第 2.3.1 节的克隆路径和第 2.3.4 节的 artifacts 路径保持一致。第 2.3.3 节的同一处也需要同步修改。


compile


ascend docs pipeline is running...


ascend docs pipeline is running...


| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_msprof_arm | 🛑 | >>> |
| Build_msprof_x86 | 🛑 | >>> | |
| 恶意代码检查 | Antipoison_msprof | 🛑 | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | 🛑 | >>> |
| pre-commit | 🛑 | >>> | |
| 开源片段检查 | SCA_msprof | 🛑 | >>> |
| 开发者测试 | UT_msprof | 🛑 | >>> |
| PreSmoke_msprof | 🛑 | >>> | |
| 流水线 | PR-pipeline_msprof | ✅ | >>> |
- compile : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


/approve


Pull Request 已合并或已关闭。
If you want to solve this problem, you can click here to do it in the FAQs.


1. 修改描述
2. 功能验证
3. 代码检视
4. 资料修改自检