Prhub

#50308 [DOC][CPU] remove tcmalloc warning from CPU docs

原始 PR 作者 fadara01 合并时间 2026-07-30 14:30 文件变更 2 提交数 1 评论 2 代码增减 +4 / -23

执行摘要

移除 CPU 文档中 tcmalloc 警告

PR body 明确指出:"This is no longer needed as tcmalloc now is now bundled into the CPU wheel and ldpreloaded by default since: https://github.com/vllm-project/vllm/pull/37607"。即用户不再需要手动安装和配置 tcmalloc,因此文档中的警告和步骤已过时,容易误导用户进行不必要的操作。

该 PR 属于日常文档维护,建议直接合入。但 x86 文档中第二处 tcmalloc 警告未被修改,建议作者或后续 PR 统一清理,确保文档一致性。

讨论亮点

该 PR 讨论极少。只有作者请求审核(@hmellor @bigPYJ1151),以及 Mergify 机器人提供了文档预览链接。bigPYJ1151 给予 Approved,无其他 review 评论或讨论。

实现拆解

  1. 修改 docs/getting_started/installation/cpu.arm.inc.md:删除 !!! warning "set LD_PRELOAD" 整个警告块(包括安装 tcmalloc、查找路径、设置环境变量的脚本),共删除 14 行。
  2. 修改 docs/getting_started/installation/cpu.x86.inc.md
    • 第一处警告块:将警告标题从 "set LD_PRELOAD" 改为 "set LD_PRELOAD"(内容未变),但内部删除 tcmalloc 相关步骤(安装、查找路径、环境变量),仅保留 Intel OpenMP 的路径查找和设置,并将 export LD_PRELOAD="$TC_PATH:$IOMP_PATH:$LD_PRELOAD" 简化为 export LD_PRELOAD="$IOMP_PATH:$LD_PRELOAD"
    • 第二处警告块(在 "Install the latest code" 之后):将 "Before use" 改为 "Before using",内容保持不变(仍保留 tcmalloc 和 Intel OpenMP 说明),共 4 行新增、9 行删除。
  3. 提交信息:一条 commit,说明变更依据和签名。
文件 模块 状态 重要度
docs/getting_started/installation/cpu.arm.inc.md 文档 modified 2.75
docs/getting_started/installation/cpu.x86.inc.md 文档 modified 2.71

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

风险极低。仅变更文档内容,不涉及代码逻辑。唯一风险是文档可能未完全反映实际情况:x86 页面中第二处警告块仍保留了 tcmalloc 说明("Before using vLLM CPU installed via wheels, make sure TCMalloc and Intel OpenMP are installed..."),与 PR 主旨(tcmalloc 已自动加载)不完全一致。但该处并未被修改,PR 只修改了第一处,可能是有意保留或遗漏。未来若 tcmalloc 完全无需手动安装,需进一步清理。

影响范围:仅影响阅读 CPU 安装文档的用户。ARM 用户不再看到 tcmalloc 警告,减少困惑;x86 用户仍看到 Intel OpenMP 相关警告,tcmalloc 警告部分移除,但仍有一处残留。
程度:极低。文档修改,无功能变化。

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论